ruma_common/identifiers/
transaction_id.rs

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