Struct UserListBuilder

pub struct UserListBuilder { /* private fields */ }

Builder for UserListRequest.

Implementations

impl UserListBuilder

pub fn before_id<VALUE: Into<String>>(self, value: VALUE) -> Self

ID of the object to use as a cursor for pagination (previous page)

pub fn after_id<VALUE: Into<String>>(self, value: VALUE) -> Self

ID of the object to use as a cursor for pagination (next page)

pub fn limit<VALUE: Into<u32>>(self, value: VALUE) -> Self

Number of items to return per page (1-1000)

pub fn email<VALUE: Into<String>>(self, value: VALUE) -> Self

Filter by user email

pub fn credentials<VALUE: Into<Credentials>>(self, value: VALUE) -> Self

Credentials for authentication (not serialized)

pub fn build(self) -> Result<UserListRequest, UserListBuilderError>

Builds a new UserListRequest.

Errors

If a required field has not been initialized.

impl UserListBuilder

pub async fn create(self) -> ApiResponseOrError<UserList>

Creates a new user list request and returns the response.

This is a convenience method that builds the request from the builder and sends it to the Users API.

Example

let credentials = Credentials::from_env();

let users = UserList::builder()
    .credentials(credentials)
    .limit(10u32)
    .create()
    .await?;

Trait Implementations

impl Clone for UserListBuilder

fn clone(&self) -> UserListBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserListBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UserListBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for UserListBuilder

fn eq(&self, other: &UserListBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserListBuilder