Struct AuthMetadata 

pub struct AuthMetadata { /* private fields */ }

Login metadata sent with auth code and verification requests.

client remains the caller’s transport identity for headers, user agents, and realtime handshakes. The HTTP auth body maps identities that the server cannot store as session client types to a compatible session type.

Implementations

impl AuthMetadata

pub fn new(device_id: impl Into<String>, client: ClientIdentity) -> Self

Creates auth metadata for a durable device id and client identity.

pub fn sdk(device_id: impl Into<String>) -> Self

Creates auth metadata using the default SDK client identity.

pub fn with_device_name(self, device_name: impl Into<String>) -> Self

Attaches a human-readable device name.

pub fn device_id(&self) -> &str

Returns the durable device id.

pub fn device_name(&self) -> Option<&str>

Returns the optional human-readable device name.

pub fn client(&self) -> &ClientIdentity

Returns the client identity used for auth requests.

Trait Implementations

impl Clone for AuthMetadata

fn clone(&self) -> AuthMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMetadata

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

Formats the value using the given formatter.

impl Eq for AuthMetadata

impl PartialEq for AuthMetadata

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