Struct ruma::ClientSecret

source ·
pub struct ClientSecret(/* private fields */);
Expand description

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§

source§

impl ClientSecret

source

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this ClientSecret.

source

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

Available on crate feature events only.

Creates a byte slice from this ClientSecret.

source§

impl ClientSecret

source

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

Available on crate feature events only.

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.

source

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

Available on crate feature events only.

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.

source

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

Available on crate feature events only.

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

source

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

Available on crate feature events only.

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

source§

impl ClientSecret

source

pub fn new() -> OwnedClientSecret

Available on crate features events and rand only.

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§

source§

impl AsRef<[u8]> for ClientSecret

source§

fn as_ref(&self) -> &[u8]

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

impl AsRef<ClientSecret> for ClientSecret

source§

fn as_ref(&self) -> &ClientSecret

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

impl AsRef<ClientSecret> for OwnedClientSecret

source§

fn as_ref(&self) -> &ClientSecret

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

impl AsRef<str> for ClientSecret

source§

fn as_ref(&self) -> &str

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

impl Borrow<ClientSecret> for OwnedClientSecret

source§

fn borrow(&self) -> &ClientSecret

Immutably borrows from an owned value. Read more
source§

impl Clone for Box<ClientSecret>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ClientSecret

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for ClientSecret

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&ClientSecret> for Arc<ClientSecret>

source§

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

Converts to this type from the input type.
source§

impl From<&ClientSecret> for Box<ClientSecret>

source§

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

Converts to this type from the input type.
source§

impl From<&ClientSecret> for OwnedClientSecret

source§

fn from(id: &ClientSecret) -> OwnedClientSecret

Converts to this type from the input type.
source§

impl From<&ClientSecret> for Rc<ClientSecret>

source§

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

Converts to this type from the input type.
source§

impl From<&ClientSecret> for String

source§

fn from(id: &ClientSecret) -> String

Converts to this type from the input type.
source§

impl From<OwnedClientSecret> for Box<ClientSecret>

source§

fn from(a: OwnedClientSecret) -> Box<ClientSecret>

Converts to this type from the input type.
source§

impl Hash for ClientSecret

source§

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

Feeds this value into the given Hasher. Read more
source§

impl Ord for ClientSecret

source§

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

This method returns an Ordering between self and other. Read more
source§

impl PartialEq<&ClientSecret> for OwnedClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<&str> for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Box<ClientSecret>> for &ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Box<ClientSecret>> for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ClientSecret> for &str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ClientSecret> for OwnedClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ClientSecret> for str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedClientSecret> for &ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedClientSecret> for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<String> for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<str> for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for ClientSecret

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for ClientSecret

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for ClientSecret

source§

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. Read more
source§

impl ToOwned for ClientSecret

§

type Owned = OwnedClientSecret

The resulting type after obtaining ownership.
source§

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

Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<&str> for Box<ClientSecret>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<String> for Box<ClientSecret>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl Eq for ClientSecret

source§

impl StructuralPartialEq for ClientSecret

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more