ruma-common 0.20.0

Common types for other ruma crates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Types for common user profile fields.

#![allow(clippy::exhaustive_structs)]

use ruma_common::OwnedMxcUri;
#[cfg(feature = "unstable-msc4426")]
use ruma_common::profile::{CallProfileField, StatusProfileField};
use serde::{Serialize, de::DeserializeOwned};

/// Trait implemented by types representing a field in a user's [profile] having a statically-known
/// name.
///
/// [profile]: https://spec.matrix.org/v1.19/client-server-api/#profiles
pub trait StaticProfileField {
    /// The type for the value of the field.
    type Value: Sized + Serialize + DeserializeOwned;

    /// The string representation of this field.
    const NAME: &str;
}

/// The user's avatar URL.
#[derive(Debug, Clone, Copy)]
pub struct AvatarUrl;

impl StaticProfileField for AvatarUrl {
    type Value = OwnedMxcUri;
    const NAME: &str = "avatar_url";
}

/// The user's display name.
#[derive(Debug, Clone, Copy)]
pub struct DisplayName;

impl StaticProfileField for DisplayName {
    type Value = String;
    const NAME: &str = "displayname";
}

/// The user's time zone.
#[derive(Debug, Clone, Copy)]
pub struct TimeZone;

impl StaticProfileField for TimeZone {
    type Value = String;
    const NAME: &str = "m.tz";
}

/// The user's current status.
#[cfg(feature = "unstable-msc4426")]
#[derive(Debug, Clone, Copy)]
pub struct Status;

#[cfg(feature = "unstable-msc4426")]
impl StaticProfileField for Status {
    type Value = StatusProfileField;
    const NAME: &str = "org.matrix.msc4426.status";
}

/// The user's call indicator.
#[cfg(feature = "unstable-msc4426")]
#[derive(Debug, Clone, Copy)]
pub struct Call;

#[cfg(feature = "unstable-msc4426")]
impl StaticProfileField for Call {
    type Value = CallProfileField;
    const NAME: &str = "org.matrix.msc4426.call";
}