essence 0.7.0

Essential models and database logic for the Adapt chat platform.
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
70
71

use crate::serde_for_bitflags;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
#[cfg(feature = "utoipa")]
use utoipa::ToSchema;

/// The status of a user's presence.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Hash, Deserialize, Serialize)]
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
#[cfg_attr(feature = "bincode", derive(bincode::Encode, bincode::Decode))]
#[serde(rename_all = "snake_case")]
pub enum PresenceStatus {
    /// The user is online and can receive notifications.
    #[default]
    Online,
    /// The user is connected but is not actively interacting with Adapt.
    Idle,
    /// The user is online or idle but will not receive any notifications.
    Dnd,
    /// The user is offline.
    Offline,
}

/// Represents the presence state (status and activity) of a user.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Deserialize, Serialize)]
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
#[cfg_attr(feature = "bincode", derive(bincode::Encode, bincode::Decode))]
pub struct Presence {
    /// The ID of the user whose presence this is.
    pub user_id: u64,
    /// The status of the user.
    pub status: PresenceStatus,
    /// The custom status of the user, if any.
    pub custom_status: Option<String>,
    /// The devices the user is present on.
    #[cfg_attr(feature = "bincode", bincode(with_serde))]
    pub devices: Devices,
    /// The time the user initially went online. This is only provided if the user is online.
    #[cfg_attr(feature = "bincode", bincode(with_serde))]
    pub online_since: Option<DateTime<Utc>>,
}

/// Represents a device a user could be present on. This is provided once during the `identify`
/// payload.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
#[cfg_attr(feature = "bincode", derive(bincode::Encode, bincode::Decode))]
#[serde(rename_all = "snake_case")]
pub enum Device {
    /// The user is present on a desktop client.
    Desktop,
    /// The user is present on a mobile client.
    Mobile,
    /// The user is present on a web client.
    Web,
}

bitflags::bitflags! {
    /// Represents all of the devices a user is present on.
    #[derive(Default)]
    pub struct Devices: u32 {
        /// The user is present on a desktop client.
        const DESKTOP = 1 << 0;
        /// The user is present on a mobile client.
        const MOBILE = 1 << 1;
        /// The user is present on a web client.
        const WEB = 1 << 2;
    }
}

serde_for_bitflags!(u32: Devices);