ruwuma/ruma-identifiers/src/opaque_ids.rs
Jonas Platte 1ceade7b61
identifiers: Add more crypto-related types
Co-authored-by: Isaiah Inuwa <isaiah.inuwa@gmail.com>
2020-12-02 13:11:28 +01:00

40 lines
984 B
Rust

//! Matrix device identifiers.
#[cfg(feature = "rand")]
use crate::generate_localpart;
opaque_identifier! {
/// A Matrix key ID.
///
/// Device identifiers in Matrix are completely opaque character sequences. This type is
/// provided simply for its semantic value.
pub type DeviceId;
}
impl DeviceId {
/// Generates a random `DeviceId`, suitable for assignment to a new device.
#[cfg(feature = "rand")]
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]
pub fn new() -> Box<Self> {
Self::from_owned(generate_localpart(8))
}
}
opaque_identifier! {
/// A Matrix key identifier.
///
/// Key identifiers in Matrix are opaque character sequences of `[a-zA-Z_]`. This type is provided
/// simply for its semantic value.
pub type KeyName;
}
#[cfg(all(test, feature = "rand"))]
mod tests {
use super::DeviceId;
#[test]
fn generate_device_id() {
assert_eq!(DeviceId::new().as_str().len(), 8);
}
}