ruma-common 0.18.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

#![allow(unexpected_cfgs)]

use ruma_common::{
    api::{Metadata, auth_scheme::AccessToken, path_builder::PathBuilder, request, response},
    metadata,
};

metadata! {
    method: PUT,
    rate_limited: true,
    authentication: AccessToken,
    path: "/_matrix/other/v1/endpoint/{baz}",
}

/// Request type for the `other_endpoint` endpoint.
#[request]
pub struct Request {
    // This value will be inserted into the request's URL in place of the
    // "{baz}" path component.
    #[ruma_api(path)]
    pub baz: String,

    // This value represents the full query string of the request's URL.
    #[ruma_api(query_all)]
    pub bar: Query,

    // This is a non-JSON body.
    #[ruma_api(raw_body)]
    pub body: Vec<u8>,
}

/// The query parameters of the `other_endpoint` endpoint.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Query {
    pub foo: String,
}

/// Response type for the `other_endpoint` endpoint.
#[response]
pub struct Response {
    // This is a non-JSON body.
    #[ruma_api(raw_body)]
    pub body: Vec<u8>,
}

fn main() {
    assert_eq!(
        Request::PATH_BUILDER.all_paths().collect::<Vec<_>>(),
        &["/_matrix/other/v1/endpoint/{baz}"],
    );

    let path = Request::PATH_BUILDER.select_path(()).unwrap();
    assert_eq!(path, "/_matrix/other/v1/endpoint/{baz}");
}