pep/xmpp-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

jingle_ibb: Add documentation.

Browse source
This commit is contained in:
Emmanuel Gil Peyrot 2018-07-02 13:51:36 +02:00
parent 5f2062483a
commit 9d3028ad71
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/jingle_ibb.rs
View file

@ -4,12 +4,22 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this // License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/. // file, You can obtain one at http://mozilla.org/MPL/2.0/.
#![deny(missing_docs)]
use ibb::{Stanza, StreamId}; use ibb::{Stanza, StreamId};
generate_element!(Transport, "transport", JINGLE_IBB, generate_element!(
/// Describes an [In-Band Bytestream](https://xmpp.org/extensions/xep-0047.html)
/// Jingle transport, see also the [IBB module](../ibb.rs).
Transport, "transport", JINGLE_IBB,
attributes: [ attributes: [
/// Maximum size in bytes for each chunk.
block_size: u16 = "block-size" => required, block_size: u16 = "block-size" => required,
/// The identifier to be used to create a stream.
sid: StreamId = "sid" => required, sid: StreamId = "sid" => required,
/// Which stanza type to use to exchange data.
stanza: Stanza = "stanza" => default, stanza: Stanza = "stanza" => default,
]); ]);