pep/xmpp-rs-mirror
1
0
Fork 0
mirror of https://gitlab.com/xmpp-rs/xmpp-rs.git synced 2024-07-12 22:21:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

blocking: Document this module.

Browse source
This commit is contained in:
Emmanuel Gil Peyrot 2018-08-02 18:15:56 +02:00
parent f7c74498cc
commit a1530c531b
1 changed files with 34 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
src/blocking.rs
View file

@ -4,6 +4,8 @@
// 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 try_from::TryFrom; use try_from::TryFrom;
use jid::Jid; use jid::Jid;
@ -14,14 +16,20 @@ use error::Error;
use ns; use ns;
use iq::{IqGetPayload, IqSetPayload, IqResultPayload}; use iq::{IqGetPayload, IqSetPayload, IqResultPayload};
generate_empty_element!(BlocklistRequest, "blocklist", BLOCKING); generate_empty_element!(
/// The element requesting the blocklist, the result iq will contain a
/// [BlocklistResult].
BlocklistRequest, "blocklist", BLOCKING
);
impl IqGetPayload for BlocklistRequest {} impl IqGetPayload for BlocklistRequest {}
macro_rules! generate_blocking_element { macro_rules! generate_blocking_element {
($elem:ident, $name:tt) => ( ($(#[$meta:meta])* $elem:ident, $name:tt) => (
$(#[$meta])*
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct $elem { pub struct $elem {
/// List of JIDs affected by this command.
pub items: Vec<Jid>, pub items: Vec<Jid>,
} }
@ -58,15 +66,35 @@ macro_rules! generate_blocking_element {
); );
} }
generate_blocking_element!(BlocklistResult, "blocklist"); generate_blocking_element!(
generate_blocking_element!(Block, "block"); /// The element containing the current blocklist, as a reply from
generate_blocking_element!(Unblock, "unblock"); /// [BlocklistRequest].
BlocklistResult, "blocklist"
);
impl IqResultPayload for BlocklistResult {} impl IqResultPayload for BlocklistResult {}
// TODO: Prevent zero elements from being allowed.
generate_blocking_element!(
/// A query to block one or more JIDs.
Block, "block"
);
impl IqSetPayload for Block {} impl IqSetPayload for Block {}
generate_blocking_element!(
/// A query to unblock one or more JIDs, or all of them.
///
/// Warning: not putting any JID there means clearing out the blocklist.
Unblock, "unblock"
);
impl IqSetPayload for Unblock {} impl IqSetPayload for Unblock {}
generate_empty_element!(Blocked, "blocked", BLOCKING_ERRORS); generate_empty_element!(
/// The application-specific error condition when a message is blocked.
Blocked, "blocked", BLOCKING_ERRORS
);
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {