concord 2.4.7

A terminal user interface client for Discord
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

mod state;

use chrono::{DateTime, Utc};

pub use state::{GuildMemberState, RoleState, TypingUserState};
pub(in crate::discord) use state::{
    role_map, role_state, selected_member_role_color, selected_role_ids_color,
};

use crate::discord::ids::{
    Id,
    marker::{RoleMarker, UserMarker},
};

pub(crate) const MEMBER_FLAG_COMPLETED_ONBOARDING: u64 = 1 << 1;
pub(crate) const MEMBER_FLAG_BYPASSES_VERIFICATION: u64 = 1 << 2;
pub(crate) const MEMBER_FLAG_STARTED_ONBOARDING: u64 = 1 << 3;

#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum MemberOnboardingStatus {
    NotStarted,
    InProgress,
    Completed,
}

pub(crate) fn onboarding_status_from_flags(flags: Option<u64>) -> Option<MemberOnboardingStatus> {
    let flags = flags?;
    if flags & MEMBER_FLAG_COMPLETED_ONBOARDING != 0 {
        Some(MemberOnboardingStatus::Completed)
    } else if flags & MEMBER_FLAG_STARTED_ONBOARDING != 0 {
        Some(MemberOnboardingStatus::InProgress)
    } else {
        Some(MemberOnboardingStatus::NotStarted)
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct MemberInfo {
    pub user_id: Id<UserMarker>,
    pub display_name: String,
    /// Discord login handle (`User.name`). Same role as in
    /// [`ChannelRecipientInfo::username`].
    pub username: Option<String>,
    pub is_bot: bool,
    pub avatar_url: Option<String>,
    pub role_ids: Vec<Id<RoleMarker>>,
    /// When this member joined the server. Required for HIGH verification.
    pub joined_at: Option<DateTime<Utc>>,
    /// Discord guild member flags, including BYPASSES_VERIFICATION.
    pub flags: Option<u64>,
    /// Whether the member still needs to complete membership screening.
    pub pending: Option<bool>,
    /// When Discord's member timeout expires. A future value temporarily
    /// restricts the member to viewing channels and reading message history.
    pub communication_disabled_until: Option<DateTime<Utc>>,
    /// Whether the source payload included `communication_disabled_until`.
    /// Discord uses an explicit null to clear a timeout, so update merging
    /// must distinguish null from an omitted field.
    pub communication_disabled_until_present: bool,
}

#[cfg(test)]
#[allow(dead_code)]
impl MemberInfo {
    pub(crate) fn test(user_id: Id<UserMarker>, display_name: impl Into<String>) -> Self {
        Self {
            user_id,
            display_name: display_name.into(),
            username: None,
            is_bot: false,
            avatar_url: None,
            role_ids: Vec::new(),
            joined_at: None,
            flags: None,
            pending: None,
            communication_disabled_until: None,
            communication_disabled_until_present: false,
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RoleInfo {
    pub id: Id<RoleMarker>,
    pub name: String,
    pub color: Option<u32>,
    pub position: i64,
    pub hoist: bool,
    /// Discord permission bitfield carried by this role. Used by
    /// `DiscordState::can_view_channel` to compute base permissions and
    /// detect ADMINISTRATOR.
    pub permissions: u64,
}

#[cfg(test)]
#[allow(dead_code)]
impl RoleInfo {
    pub(crate) fn test(id: Id<RoleMarker>, name: impl Into<String>) -> Self {
        Self {
            id,
            name: name.into(),
            color: None,
            position: 0,
            hoist: false,
            permissions: 0,
        }
    }
}