Skip to main content

ruma_common/identifiers/
server_signing_key_version.rs

1use ruma_macros::IdDst;
2
3use super::{IdParseError, KeyName};
4
5/// The version of a [homeserver signing key].
6///
7/// This is an opaque character sequences of `[a-zA-Z0-9_]`. This type is provided simply for its
8/// semantic value.
9///
10/// With the `compat-server-signing-key-version` cargo feature, the validation of this type is
11/// relaxed to accept any string.
12///
13/// [homeserver signing key]: https://spec.matrix.org/v1.19/server-server-api/#retrieving-server-keys
14#[repr(transparent)]
15#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, IdDst)]
16#[ruma_id(
17    validate = ruma_identifiers_validation::server_signing_key_version::validate,
18    smallvec_inline_bytes = 16,
19)]
20pub struct ServerSigningKeyVersion(str);
21
22impl KeyName for ServerSigningKeyVersion {
23    fn validate(s: &str) -> Result<(), IdParseError> {
24        ruma_identifiers_validation::server_signing_key_version::validate(s)
25    }
26}
27
28impl KeyName for OwnedServerSigningKeyVersion {
29    fn validate(s: &str) -> Result<(), IdParseError> {
30        ruma_identifiers_validation::server_signing_key_version::validate(s)
31    }
32}