Struct UserBuilder

pub struct UserBuilder { /* private fields */ }

Builder for UserRequest.

Implementations

impl UserBuilder

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

User identifier

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

Credentials for authentication (not serialized)

pub fn build(self) -> Result<UserRequest, UserBuilderError>

Builds a new UserRequest.

Errors

If a required field has not been initialized.

impl UserBuilder

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

Creates a new user 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 user = User::builder("user_123456789")
    .credentials(credentials)
    .create()
    .await?;

Trait Implementations

impl Clone for UserBuilder

fn clone(&self) -> UserBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserBuilder

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

Formats the value using the given formatter.

impl Default for UserBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for UserBuilder

fn eq(&self, other: &UserBuilder) -> 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 UserBuilder