Struct ClientIdentity 

pub struct ClientIdentity { /* private fields */ }

Application identity sent with Inline HTTP and realtime requests.

Use ClientIdentity::sdk() for low-level SDK callers, or pass your own application-specific type such as cli, matrix-bridge, or agent.

Implementations

impl ClientIdentity

pub fn new( client_type: impl Into<String>, client_version: impl Into<String>, ) -> ClientIdentity

Creates a client identity and panics if the values are invalid.

This is intended for static or already-validated values. Use ClientIdentity::try_new when accepting user or config input.

Panics

Panics when either field is empty after trimming or cannot be represented as an HTTP header value.

pub fn try_new( client_type: impl Into<String>, client_version: impl Into<String>, ) -> Result<ClientIdentity, ClientIdentityError>

Creates a client identity after trimming and validating header values.

pub fn sdk() -> ClientIdentity

Returns the default SDK identity for this crate version.

pub fn client_type(&self) -> &str

Returns the Inline client type, such as rust-sdk or cli.

pub fn client_version(&self) -> &str

Returns the application version sent to Inline.

Trait Implementations

impl Clone for ClientIdentity

fn clone(&self) -> ClientIdentity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientIdentity

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

Formats the value using the given formatter.

impl Default for ClientIdentity

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ClientIdentity

impl PartialEq for ClientIdentity

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