ruma_common/identifiers/
voip_id.rs

1//! VoIP identifier.
2
3use ruma_macros::IdZst;
4
5/// A VoIP identifier.
6///
7/// VoIP IDs in Matrix are opaque strings. This type is provided simply for its semantic
8/// value.
9///
10/// You can create one from a string (using `VoipId::parse()`) but the recommended way is to
11/// use `VoipId::new()` to generate a random one. If that function is not available for you,
12/// you need to activate this crate's `rand` Cargo feature.
13#[repr(transparent)]
14#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, IdZst)]
15pub struct VoipId(str);
16
17impl VoipId {
18    /// Creates a random VoIP identifier.
19    ///
20    /// This will currently be a UUID without hyphens, but no guarantees are made about the
21    /// structure of client secrets generated from this function.
22    #[cfg(feature = "rand")]
23    #[allow(clippy::new_ret_no_self)]
24    pub fn new() -> OwnedVoipId {
25        let id = uuid::Uuid::new_v4();
26        VoipId::from_borrowed(&id.simple().to_string()).to_owned()
27    }
28}