palpo-core 0.0.2

Core library used by the palpo 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
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
146
147
148
149
150
151
152
153

use salvo::prelude::*;
use serde::{Deserialize, Serialize};

use crate::OwnedServerName;
/// `POST /_matrix/client/*/publicRooms`
///
/// Get the list of rooms in this homeserver's public directory.
/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3publicrooms
use crate::directory::{PublicRoomFilter, RoomNetwork};
use crate::room::Visibility;

// const METADATA: Metadata = metadata! {
//     method: POST,
//     rate_limited: false,
//     authentication: AccessToken,
//     history: {
//         1.0 => "/_matrix/client/r0/publicRooms",
//         1.1 => "/_matrix/client/v3/publicRooms",
//     }
// };

/// Request type for the `get_filtered_public_rooms` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct PublicRoomsFilteredReqBody {
    /// The server to fetch the public room lists from.
    ///
    /// `None` means the server this request is sent to.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[salvo(parameter(parameter_in = Query))]
    pub server: Option<OwnedServerName>,

    /// Limit for the number of results to return.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<usize>,

    /// Pagination token from a previous request.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub since: Option<String>,

    /// Filter to apply to the results.
    #[serde(default, skip_serializing_if = "PublicRoomFilter::is_empty")]
    pub filter: PublicRoomFilter,

    /// Network to fetch the public room lists from.
    #[serde(flatten, skip_serializing_if = "crate::serde::is_default")]
    pub room_network: RoomNetwork,
}

/// `GET /_matrix/client/*/publicRooms`
///
/// Get the list of rooms in this homeserver's public directory.

/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3publicrooms

// const METADATA: Metadata = metadata! {
//     method: GET,
//     rate_limited: false,
//     authentication: None,
//     history: {
//         1.0 => "/_matrix/client/r0/publicRooms",
//         1.1 => "/_matrix/client/v3/publicRooms",
//     }
// };

/// Request type for the `get_public_rooms` endpoint.
#[derive(ToParameters, Deserialize, Debug)]
pub struct PublicRoomsReqArgs {
    /// Limit for the number of results to return.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[salvo(parameter(parameter_in = Query))]
    pub limit: Option<usize>,

    /// Pagination token from a previous request.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[salvo(parameter(parameter_in = Query))]
    pub since: Option<String>,

    /// The server to fetch the public room lists from.
    ///
    /// `None` means the server this request is sent to.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[salvo(parameter(parameter_in = Query))]
    pub server: Option<OwnedServerName>,
}

/// `GET /_matrix/client/*/directory/list/room/{room_id}`
///
/// Get the visibility of a public room on a directory.
/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3directorylistroomroomid

// const METADATA: Metadata = metadata! {
//     method: GET,
//     rate_limited: false,
//     authentication: None,
//     history: {
//         1.0 => "/_matrix/client/r0/directory/list/room/:room_id",
//         1.1 => "/_matrix/client/v3/directory/list/room/:room_id",
//     }
// };

/// Request type for the `get_room_visibility` endpoint.

// pub struct Requestx {
//     /// The ID of the room of which to request the visibility.
//     #[salvo(parameter(parameter_in = Path))]
//     pub room_id: OwnedRoomId,
// }

/// Response type for the `get_room_visibility` endpoint.
#[derive(ToSchema, Serialize, Debug)]
pub struct VisibilityResBody {
    /// Visibility of the room.
    pub visibility: Visibility,
}

impl VisibilityResBody {
    /// Creates a new `Response` with the given visibility.
    pub fn new(visibility: Visibility) -> Self {
        Self { visibility }
    }
}

/// `PUT /_matrix/client/*/directory/list/room/{room_id}`
///
/// Set the visibility of a public room on a directory.
/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3directorylistroomroomid
// const METADATA: Metadata = metadata! {
//     method: PUT,
//     rate_limited: false,
//     authentication: AccessToken,
//     history: {
//         1.0 => "/_matrix/client/r0/directory/list/room/:room_id",
//         1.1 => "/_matrix/client/v3/directory/list/room/:room_id",
//     }
// };

/// Request type for the `set_room_visibility` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct SetRoomVisibilityReqBody {
    // /// The ID of the room of which to set the visibility.
    // #[salvo(parameter(parameter_in = Path))]
    // pub room_id: OwnedRoomId,
    /// New visibility setting for the room.
    pub visibility: Visibility,
}