harmony_rust_sdk 0.3.0

Rust library to work with the Harmony chat protocol.
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use super::*;

client_api! {
    /// Get channels all channels (that you have permission to view) in a guild.
    action: GetGuildChannels,
    api_fn: get_guild_channels,
    service: chat,
}

/// Convenience type to create a valid [`GetChannelMessagesRequest`].
///
/// If `before_message_id` is not specified, it will default to `0`, which
/// means the server should return the latest messages.
///
/// Note that the number of messages returned may be limited by servers.
#[into_request("GetChannelMessagesRequest")]
#[derive(Debug, new, SelfBuilder)]
pub struct GetChannelMessages {
    guild_id: u64,
    channel_id: u64,
    #[new(default)]
    before_message: u64,
}

client_api! {
    /// Get messages before a message in a channel of a guild.
    action: GetChannelMessages,
    api_fn: get_channel_messages,
    service: chat,
}

/// Convenience type to create a valid [`CreateChannelRequest`].
#[derive(Debug, new, SelfBuilder)]
pub struct CreateChannel {
    guild_id: u64,
    channel_name: String,
    channel_place: Place,
    #[new(default)]
    #[builder(setter(strip_option))]
    metadata: Option<Metadata>,
    #[new(default)]
    is_category: bool,
}

impl IntoRequest<CreateChannelRequest> for CreateChannel {
    fn into_request(self) -> Request<CreateChannelRequest> {
        CreateChannelRequest {
            guild_id: self.guild_id,
            channel_name: self.channel_name,
            previous_id: self.channel_place.previous(),
            next_id: self.channel_place.next(),
            metadata: self.metadata,
            is_category: self.is_category,
        }
        .into_request()
    }
}

client_api! {
    /// Create a channel.
    action: CreateChannel,
    api_fn: create_channel,
    service: chat,
}

/// Convenience type to create a valid [`DeleteChannelRequest`].
#[into_request("DeleteChannelRequest")]
#[derive(Debug, new)]
pub struct DeleteChannel {
    guild_id: u64,
    channel_id: u64,
}

client_api! {
    /// Delete a channel.
    request: DeleteChannelRequest,
    api_fn: delete_channel,
    service: chat,
}

/// Convenience type to create a valid [`UpdateChannelInformationRequest`].
#[into_request("UpdateChannelInformationRequest")]
#[derive(Debug, new)]
pub struct UpdateChannelInformation {
    guild_id: u64,
    channel_id: u64,
    #[new(default)]
    name: String,
    #[new(default)]
    metadata: Option<Metadata>,
    #[new(default)]
    update_name: bool,
    #[new(default)]
    update_metadata: bool,
}

impl UpdateChannelInformation {
    /// Set new name for this channel.
    pub fn new_channel_name(mut self, channel_name: impl Into<String>) -> Self {
        self.name = channel_name.into();
        self.update_name = true;
        self
    }

    /// Set new metadata for this channel.
    pub fn new_metadata(mut self, metadata: impl Into<Option<Metadata>>) -> Self {
        self.metadata = metadata.into();
        self.update_metadata = true;
        self
    }
}

client_api! {
    /// Update a channel's information.
    request: UpdateChannelInformationRequest,
    api_fn: update_channel_information,
    service: chat,
}

/// Convenience type to create a valid [`UpdateChannelOrderRequest`].
#[derive(Debug, new)]
pub struct UpdateChannelOrder {
    guild_id: u64,
    channel_id: u64,
    new_channel_place: Place,
}

impl IntoRequest<UpdateChannelOrderRequest> for UpdateChannelOrder {
    fn into_request(self) -> Request<UpdateChannelOrderRequest> {
        UpdateChannelOrderRequest {
            guild_id: self.guild_id,
            channel_id: self.channel_id,
            previous_id: self.new_channel_place.previous(),
            next_id: self.new_channel_place.next(),
        }
        .into_request()
    }
}

client_api! {
    /// Update a channel's place in the channel list.
    request: UpdateChannelOrderRequest,
    api_fn: update_channel_order,
    service: chat,
}