mirror of
https://gitlab.com/xmpp-rs/xmpp-rs.git
synced 2024-07-12 22:21:53 +00:00
jingle_ibb: Add documentation.
This commit is contained in:
parent
5f2062483a
commit
9d3028ad71
1 changed files with 11 additions and 1 deletions
|
@ -4,12 +4,22 @@
|
|||
// 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/.
|
||||
|
||||
#![deny(missing_docs)]
|
||||
|
||||
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: [
|
||||
/// Maximum size in bytes for each chunk.
|
||||
block_size: u16 = "block-size" => required,
|
||||
|
||||
/// The identifier to be used to create a stream.
|
||||
sid: StreamId = "sid" => required,
|
||||
|
||||
/// Which stanza type to use to exchange data.
|
||||
stanza: Stanza = "stanza" => default,
|
||||
]);
|
||||
|
||||
|
|
Loading…
Reference in a new issue