Struct LoginRequest 

pub struct LoginRequest {
    pub hostname: Option<String>,
    pub invite_code: Option<String>,
    pub display_name: Option<String>,
}

Fields

hostname: Option<String>

invite_code: Option<String>

Single-use invite token required when the relay has no OAuth provider configured. Ignored on OAuth-enabled relays (they reject /auth/login entirely). Format: “cinch_inv_”.

display_name: Option<String>

Friendly display name the user types at the browser sign-in page. Stored on users.display_name; shown in relay user list.

Implementations

impl LoginRequest

pub fn hostname(&self) -> &str

Returns the value of hostname, or the default value if hostname is unset.

pub fn invite_code(&self) -> &str

Returns the value of invite_code, or the default value if invite_code is unset.

pub fn display_name(&self) -> &str

Returns the value of display_name, or the default value if display_name is unset.

Trait Implementations

impl Clone for LoginRequest

fn clone(&self) -> LoginRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoginRequest

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

Formats the value using the given formatter.

impl Default for LoginRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LoginRequest

where LoginRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for LoginRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for LoginRequest

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoginRequest