ruma_identity_service_api/
lookup.rs

1//! Endpoints to look up Matrix IDs bound to 3PIDs.
2
3use ruma_common::serde::StringEnum;
4
5use crate::PrivOwnedStr;
6
7pub mod get_hash_parameters;
8pub mod lookup_3pid;
9
10/// The algorithms that can be used to hash the identifiers used for lookup, as defined in the
11/// Matrix Spec.
12///
13/// This type can hold an arbitrary string. To build this with a custom value, convert it from a
14/// string with `::from()` / `.into()`. To check for values that are not available as a documented
15/// variant here, use its string representation, obtained through [`.as_str()`](Self::as_str()).
16#[derive(Clone, PartialEq, Eq, StringEnum)]
17#[non_exhaustive]
18#[ruma_enum(rename_all = "snake_case")]
19pub enum IdentifierHashingAlgorithm {
20    /// The SHA-256 hashing algorithm.
21    Sha256,
22
23    /// No algorithm is used, and identifier strings are directly used for lookup.
24    None,
25
26    #[doc(hidden)]
27    _Custom(PrivOwnedStr),
28}
29
30#[cfg(test)]
31mod tests {
32    use super::IdentifierHashingAlgorithm;
33
34    #[test]
35    fn parse_identifier_hashing_algorithm() {
36        assert_eq!(IdentifierHashingAlgorithm::from("sha256"), IdentifierHashingAlgorithm::Sha256);
37        assert_eq!(IdentifierHashingAlgorithm::from("none"), IdentifierHashingAlgorithm::None);
38    }
39}