Struct ruma::ClientSecret

#[repr(transparent)]
pub struct ClientSecret(_);

A client secret.

Client secrets in Matrix are opaque character sequences of [0-9a-zA-Z.=_-]. Their length must must not exceed 255 characters.

You can create one from a string (using ClientSecret::parse()) but the recommended way is to use ClientSecret::new() to generate a random one. If that function is not available for you, you need to activate this crate’s rand Cargo feature.

Implementations

impl ClientSecret

pub fn as_str(&self) -> &str

Creates a string slice from this ClientSecret.

pub fn as_bytes(&self) -> &[u8]

Creates a byte slice from this ClientSecret.

impl ClientSecret

pub fn parse(s: impl AsRef<str>) -> Result<OwnedClientSecret, Error>

Try parsing a &str into an OwnedClientSecret.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_box(
    s: impl AsRef<str> + Into<Box<str, Global>>
) -> Result<Box<ClientSecret, Global>, Error>

Try parsing a &str into a Box<ClientSecret>.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_rc(
    s: impl AsRef<str> + Into<Rc<str>>
) -> Result<Rc<ClientSecret>, Error>

Try parsing a &str into an Rc<ClientSecret>.

pub fn parse_arc(
    s: impl AsRef<str> + Into<Arc<str>>
) -> Result<Arc<ClientSecret>, Error>

Try parsing a &str into an Arc<ClientSecret>.

impl ClientSecret

pub fn new() -> OwnedClientSecret

Creates a random client secret.

This will currently be a UUID without hyphens, but no guarantees are made about the structure of client secrets generated from this function.

Trait Implementations

impl AsRef<ClientSecret> for OwnedClientSecret

fn as_ref(&self) -> &ClientSecret

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for ClientSecret

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<ClientSecret> for OwnedClientSecret

fn borrow(&self) -> &ClientSecret

Immutably borrows from an owned value.

impl Clone for Box<ClientSecret, Global>

fn clone(&self) -> Box<ClientSecret, Global>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientSecret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Box<ClientSecret, Global>

fn deserialize<D>(
    deserializer: D
) -> Result<Box<ClientSecret, Global>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ClientSecret

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

Formats the value using the given formatter.

impl<'_> From<&ClientSecret> for String

fn from(id: &ClientSecret) -> String

Converts to this type from the input type.

impl<'_> From<&ClientSecret> for Box<ClientSecret, Global>

fn from(id: &ClientSecret) -> Box<ClientSecret, Global>

Converts to this type from the input type.

impl<'_> From<&ClientSecret> for OwnedClientSecret

fn from(id: &ClientSecret) -> OwnedClientSecret

Converts to this type from the input type.

impl<'_> From<&ClientSecret> for Rc<ClientSecret>

fn from(s: &ClientSecret) -> Rc<ClientSecret>

Converts to this type from the input type.

impl<'_> From<&ClientSecret> for Arc<ClientSecret>

fn from(s: &ClientSecret) -> Arc<ClientSecret>

Converts to this type from the input type.

impl Hash for ClientSecret

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ClientSecret

fn cmp(&self, other: &ClientSecret) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'_> PartialEq<&ClientSecret> for OwnedClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'_> PartialEq<&str> for ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'_> PartialEq<Box<ClientSecret, Global>> for &ClientSecret

fn eq(&self, other: &Box<ClientSecret, Global>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Box<ClientSecret, Global>> for ClientSecret

fn eq(&self, other: &Box<ClientSecret, Global>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'_> PartialEq<ClientSecret> for &str

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ClientSecret> for OwnedClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ClientSecret> for ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ClientSecret> for str

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'_> PartialEq<OwnedClientSecret> for &ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<OwnedClientSecret> for ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<String> for ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<str> for ClientSecret

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ClientSecret> for ClientSecret

fn partial_cmp(&self, other: &ClientSecret) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ClientSecret

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl ToOwned for ClientSecret

type Owned = OwnedClientSecret

The resulting type after obtaining ownership.

fn to_owned(&self) -> <ClientSecret as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a ClientSecret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: &'a str
) -> Result<&'a ClientSecret, <&'a ClientSecret as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'_> TryFrom<&str> for Box<ClientSecret, Global>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: &str
) -> Result<Box<ClientSecret, Global>, <Box<ClientSecret, Global> as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Box<ClientSecret, Global>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: String
) -> Result<Box<ClientSecret, Global>, <Box<ClientSecret, Global> as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for ClientSecret

impl StructuralEq for ClientSecret

impl StructuralPartialEq for ClientSecret