Garmelon/euphoxide
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve api documentation

Browse source
This commit is contained in:
Joscha 2022-08-22 16:45:25 +02:00
parent 5ac16db3fc
commit b2400b60ad
2 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/api/room_cmds.rs
View file

@ -1,4 +1,7 @@
//! Chat room commands.
//!
//! These commands are available to the client once a session successfully joins
//! a room.
use serde::{Deserialize, Serialize};
@ -17,8 +20,9 @@ pub struct GetMessageReply(pub Message);
/// Request messages from the room's message log.
///
/// This can be used to supplement the log provided by snapshot-event (for
/// example, when scrolling back further in history).
/// This can be used to supplement the log provided by
/// [`SnapshotEvent`](super::SnapshotEvent) (for example, when scrolling back
/// further in history).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Log {
/// Maximum number of messages to return (up to 1000).