mirror of
https://gitlab.com/xmpp-rs/xmpp-rs.git
synced 2024-07-12 22:21:53 +00:00
attention, chatstates, eme, ping: Add a docstring on the structs.
This commit is contained in:
parent
fd31e691af
commit
7612c53f9a
4 changed files with 18 additions and 0 deletions
|
@ -12,6 +12,7 @@ use error::Error;
|
||||||
|
|
||||||
use ns;
|
use ns;
|
||||||
|
|
||||||
|
/// Structure representing an `<attention xmlns='urn:xmpp:attention:0'/>` element.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Attention;
|
pub struct Attention;
|
||||||
|
|
||||||
|
|
|
@ -12,12 +12,23 @@ use error::Error;
|
||||||
|
|
||||||
use ns;
|
use ns;
|
||||||
|
|
||||||
|
/// Enum representing chatstate elements part of the
|
||||||
|
/// `http://jabber.org/protocol/chatstates` namespace.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub enum ChatState {
|
pub enum ChatState {
|
||||||
|
/// `<active xmlns='http://jabber.org/protocol/chatstates'/>`
|
||||||
Active,
|
Active,
|
||||||
|
|
||||||
|
/// `<composing xmlns='http://jabber.org/protocol/chatstates'/>`
|
||||||
Composing,
|
Composing,
|
||||||
|
|
||||||
|
/// `<gone xmlns='http://jabber.org/protocol/chatstates'/>`
|
||||||
Gone,
|
Gone,
|
||||||
|
|
||||||
|
/// `<inactive xmlns='http://jabber.org/protocol/chatstates'/>`
|
||||||
Inactive,
|
Inactive,
|
||||||
|
|
||||||
|
/// `<paused xmlns='http://jabber.org/protocol/chatstates'/>`
|
||||||
Paused,
|
Paused,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -12,9 +12,14 @@ use error::Error;
|
||||||
|
|
||||||
use ns;
|
use ns;
|
||||||
|
|
||||||
|
/// Structure representing an `<encryption xmlns='urn:xmpp:eme:0'/>` element.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct ExplicitMessageEncryption {
|
pub struct ExplicitMessageEncryption {
|
||||||
|
/// Namespace of the encryption scheme used.
|
||||||
pub namespace: String,
|
pub namespace: String,
|
||||||
|
|
||||||
|
/// User-friendly name for the encryption scheme, should be `None` for OTR,
|
||||||
|
/// legacy OpenPGP and OX.
|
||||||
pub name: Option<String>,
|
pub name: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,7 @@ use error::Error;
|
||||||
|
|
||||||
use ns;
|
use ns;
|
||||||
|
|
||||||
|
/// Structure representing a `<ping xmlns='urn:xmpp:ping'/>` element.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Ping;
|
pub struct Ping;
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue