Struct ruma::VoipId

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

A VoIP identifier.

VoIP IDs in Matrix are opaque strings. This type is provided simply for its semantic value.

You can create one from a string (using VoipId::parse()) but the recommended way is to use VoipId::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 VoipId

source

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this VoipId.

source

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

Available on crate feature events only.

Creates a byte slice from this VoipId.

source§

impl VoipId

source

pub fn new() -> OwnedVoipId

Available on crate features events and rand only.

Creates a random VoIP identifier.

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 VoipId

source§

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

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

impl AsRef<VoipId> for OwnedVoipId

source§

fn as_ref(&self) -> &VoipId

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

impl AsRef<VoipId> for VoipId

source§

fn as_ref(&self) -> &VoipId

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

impl AsRef<str> for VoipId

source§

fn as_ref(&self) -> &str

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

impl Borrow<VoipId> for OwnedVoipId

source§

fn borrow(&self) -> &VoipId

Immutably borrows from an owned value. Read more
source§

impl Clone for Box<VoipId>

source§

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

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 VoipId

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<VoipId>

source§

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

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

impl Display for VoipId

source§

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

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

impl From<&VoipId> for Arc<VoipId>

source§

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

Converts to this type from the input type.
source§

impl From<&VoipId> for Box<VoipId>

source§

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

Converts to this type from the input type.
source§

impl From<&VoipId> for OwnedVoipId

source§

fn from(id: &VoipId) -> OwnedVoipId

Converts to this type from the input type.
source§

impl From<&VoipId> for Rc<VoipId>

source§

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

Converts to this type from the input type.
source§

impl From<&VoipId> for String

source§

fn from(id: &VoipId) -> String

Converts to this type from the input type.
source§

impl<'a> From<&'a str> for &'a VoipId

source§

fn from(s: &'a str) -> &'a VoipId

Converts to this type from the input type.
source§

impl From<&str> for Box<VoipId>

source§

fn from(s: &str) -> Box<VoipId>

Converts to this type from the input type.
source§

impl From<Box<str>> for Box<VoipId>

source§

fn from(s: Box<str>) -> Box<VoipId>

Converts to this type from the input type.
source§

impl From<OwnedVoipId> for Box<VoipId>

source§

fn from(a: OwnedVoipId) -> Box<VoipId>

Converts to this type from the input type.
source§

impl From<String> for Box<VoipId>

source§

fn from(s: String) -> Box<VoipId>

Converts to this type from the input type.
source§

impl Hash for VoipId

source§

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

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

impl Ord for VoipId

source§

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

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

impl PartialEq<&VoipId> for OwnedVoipId

source§

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

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<VoipId>> for &VoipId

source§

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

source§

fn eq(&self, other: &Box<VoipId>) -> 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<OwnedVoipId> for &VoipId

source§

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

source§

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

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<VoipId> for &str

source§

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

source§

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

source§

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

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 VoipId

source§

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

source§

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

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 VoipId

§

type Owned = OwnedVoipId

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> <VoipId 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 Eq for VoipId

source§

impl StructuralPartialEq for VoipId

Auto Trait Implementations§

§

impl RefUnwindSafe for VoipId

§

impl Send for VoipId

§

impl !Sized for VoipId

§

impl Sync for VoipId

§

impl Unpin for VoipId

§

impl UnwindSafe for VoipId

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