ruma_client_api/typing/
create_typing_event.rs

Help
1//! `PUT /_matrix/client/*/rooms/{roomId}/typing/{userId}`
2//!
3//! Send a typing event to a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3roomsroomidtypinguserid
9
10    use std::time::Duration;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata, OwnedRoomId, OwnedUserId,
15    };
16    use serde::{de::Error, Deserialize, Deserializer, Serialize};
17
18    const METADATA: Metadata = metadata! {
19        method: PUT,
20        authentication: AccessToken,
21        rate_limited: true,
22        history: {
23            1.0 => "/_matrix/client/r0/rooms/:room_id/typing/:user_id",
24            1.1 => "/_matrix/client/v3/rooms/:room_id/typing/:user_id",
25        }
26    };
27
28    /// Request type for the `create_typing_event` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// The room in which the user is typing.
32        #[ruma_api(path)]
33        pub room_id: OwnedRoomId,
34
35        /// The user who has started to type.
36        #[ruma_api(path)]
37        pub user_id: OwnedUserId,
38
39        /// Whether the user is typing within a length of time or not.
40        #[ruma_api(body)]
41        pub state: Typing,
42    }
43
44    /// Response type for the `create_typing_event` endpoint.
45    #[response(error = crate::Error)]
46    #[derive(Default)]
47    pub struct Response {}
48
49    impl Request {
50        /// Creates a new `Request` with the given user ID, room ID and typing state.
51        pub fn new(user_id: OwnedUserId, room_id: OwnedRoomId, state: Typing) -> Self {
52            Self { user_id, room_id, state }
53        }
54    }
55
56    impl Response {
57        /// Creates an empty `Response`.
58        pub fn new() -> Self {
59            Self {}
60        }
61    }
62
63    /// A mark for whether the user is typing within a length of time or not.
64    #[derive(Clone, Copy, Debug, Serialize)]
65    #[serde(into = "TypingInner")]
66    #[allow(clippy::exhaustive_enums)]
67    pub enum Typing {
68        /// Not typing.
69        No,
70
71        /// Typing during the specified length of time.
72        Yes(Duration),
73    }
74
75    #[derive(Deserialize, Serialize)]
76    struct TypingInner {
77        typing: bool,
78
79        #[serde(
80            with = "ruma_common::serde::duration::opt_ms",
81            default,
82            skip_serializing_if = "Option::is_none"
83        )]
84        timeout: Option<Duration>,
85    }
86
87    impl From<Typing> for TypingInner {
88        fn from(typing: Typing) -> Self {
89            match typing {
90                Typing::No => Self { typing: false, timeout: None },
91                Typing::Yes(time) => Self { typing: true, timeout: Some(time) },
92            }
93        }
94    }
95
96    impl<'de> Deserialize<'de> for Typing {
97        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
98        where
99            D: Deserializer<'de>,
100        {
101            let inner = TypingInner::deserialize(deserializer)?;
102
103            match (inner.typing, inner.timeout) {
104                (false, _) => Ok(Self::No),
105                (true, Some(time)) => Ok(Self::Yes(time)),
106                _ => Err(D::Error::missing_field("timeout")),
107            }
108        }
109    }
110}
ruma_client_api/typing/create_typing_event.rs

ruma_client_api/typing/
create_typing_event.rs
