Struct ruma_common::VoipId

pub struct VoipId(/* private fields */);

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

impl VoipId

pub fn as_str(&self) -> &str

Creates a string slice from this VoipId.

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

Creates a byte slice from this VoipId.

impl VoipId

pub fn new() -> OwnedVoipId

Available on crate feature 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

impl AsRef<[u8]> for Box<VoipId>

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

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

impl AsRef<[u8]> for VoipId

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

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

impl AsRef<VoipId> for OwnedVoipId

fn as_ref(&self) -> &VoipId

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

impl AsRef<VoipId> for VoipId

fn as_ref(&self) -> &VoipId

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

impl AsRef<str> for Box<VoipId>

fn as_ref(&self) -> &str

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

impl AsRef<str> for VoipId

fn as_ref(&self) -> &str

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

impl Borrow<VoipId> for OwnedVoipId

fn borrow(&self) -> &VoipId

Immutably borrows from an owned value.

impl Clone for Box<VoipId>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VoipId

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VoipId

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

Formats the value using the given formatter.

impl From<&VoipId> for Arc<VoipId>

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

Converts to this type from the input type.

impl From<&VoipId> for Box<VoipId>

fn from(id: &VoipId) -> Self

Converts to this type from the input type.

impl From<&VoipId> for OwnedVoipId

fn from(id: &VoipId) -> OwnedVoipId

Converts to this type from the input type.

impl From<&VoipId> for Rc<VoipId>

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

Converts to this type from the input type.

impl From<&VoipId> for String

fn from(id: &VoipId) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&str> for Box<VoipId>

fn from(s: &str) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<OwnedVoipId> for Box<VoipId>

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

Converts to this type from the input type.

impl From<String> for Box<VoipId>

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for VoipId

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

Feeds this value into the given Hasher.

impl Ord for VoipId

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

This method returns an Ordering between self and other.

impl PartialEq<&VoipId> for Box<VoipId>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for VoipId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToOwned for VoipId

type Owned = OwnedVoipId

The resulting type after obtaining ownership.

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

impl StructuralPartialEq for VoipId