139 lines
4.5 KiB
Rust
139 lines
4.5 KiB
Rust
// Copyright (c) 2017 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
|
||
//
|
||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||
// 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 helpers::Base64;
|
||
use iq::IqSetPayload;
|
||
|
||
generate_id!(
|
||
/// An identifier matching a stream.
|
||
StreamId);
|
||
|
||
generate_attribute!(
|
||
/// Which stanza type to use to exchange data.
|
||
Stanza, "stanza", {
|
||
/// `<iq/>` gives a feedback on whether the chunk has been received or not,
|
||
/// which is useful in the case the recipient might not receive them in a
|
||
/// timely manner, or to do your own throttling based on the results.
|
||
Iq => "iq",
|
||
|
||
/// `<message/>` can be faster, since it doesn’t require any feedback, but in
|
||
/// practice it will be throttled by the servers on the way.
|
||
Message => "message",
|
||
}, Default = Iq);
|
||
|
||
generate_element!(
|
||
/// Starts an In-Band Bytestream session with the given parameters.
|
||
Open, "open", 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,
|
||
]);
|
||
|
||
impl IqSetPayload for Open {}
|
||
|
||
generate_element!(
|
||
/// Exchange a chunk of data in an open stream.
|
||
Data, "data", IBB,
|
||
attributes: [
|
||
/// Sequence number of this chunk, must wraparound after 65535.
|
||
seq: u16 = "seq" => required,
|
||
|
||
/// The identifier of the stream on which data is being exchanged.
|
||
sid: StreamId = "sid" => required
|
||
],
|
||
text: (
|
||
/// Vector of bytes to be exchanged.
|
||
data: Base64<Vec<u8>>
|
||
)
|
||
);
|
||
|
||
impl IqSetPayload for Data {}
|
||
|
||
generate_element!(
|
||
/// Close an open stream.
|
||
Close, "close", IBB,
|
||
attributes: [
|
||
/// The identifier of the stream to be closed.
|
||
sid: StreamId = "sid" => required,
|
||
]);
|
||
|
||
impl IqSetPayload for Close {}
|
||
|
||
#[cfg(test)]
|
||
mod tests {
|
||
use super::*;
|
||
use try_from::TryFrom;
|
||
use minidom::Element;
|
||
use error::Error;
|
||
use std::error::Error as StdError;
|
||
|
||
#[test]
|
||
fn test_simple() {
|
||
let sid = StreamId(String::from("coucou"));
|
||
|
||
let elem: Element = "<open xmlns='http://jabber.org/protocol/ibb' block-size='3' sid='coucou'/>".parse().unwrap();
|
||
let open = Open::try_from(elem).unwrap();
|
||
assert_eq!(open.block_size, 3);
|
||
assert_eq!(open.sid, sid);
|
||
assert_eq!(open.stanza, Stanza::Iq);
|
||
|
||
let elem: Element = "<data xmlns='http://jabber.org/protocol/ibb' seq='0' sid='coucou'>AAAA</data>".parse().unwrap();
|
||
let data = Data::try_from(elem).unwrap();
|
||
assert_eq!(data.seq, 0);
|
||
assert_eq!(data.sid, sid);
|
||
assert_eq!(data.data, vec!(0, 0, 0));
|
||
|
||
let elem: Element = "<close xmlns='http://jabber.org/protocol/ibb' sid='coucou'/>".parse().unwrap();
|
||
let close = Close::try_from(elem).unwrap();
|
||
assert_eq!(close.sid, sid);
|
||
}
|
||
|
||
#[test]
|
||
fn test_invalid() {
|
||
let elem: Element = "<open xmlns='http://jabber.org/protocol/ibb'/>".parse().unwrap();
|
||
let error = Open::try_from(elem).unwrap_err();
|
||
let message = match error {
|
||
Error::ParseError(string) => string,
|
||
_ => panic!(),
|
||
};
|
||
assert_eq!(message, "Required attribute 'block-size' missing.");
|
||
|
||
let elem: Element = "<open xmlns='http://jabber.org/protocol/ibb' block-size='-5'/>".parse().unwrap();
|
||
let error = Open::try_from(elem).unwrap_err();
|
||
let message = match error {
|
||
Error::ParseIntError(error) => error,
|
||
_ => panic!(),
|
||
};
|
||
assert_eq!(message.description(), "invalid digit found in string");
|
||
|
||
let elem: Element = "<open xmlns='http://jabber.org/protocol/ibb' block-size='128'/>".parse().unwrap();
|
||
let error = Open::try_from(elem).unwrap_err();
|
||
let message = match error {
|
||
Error::ParseError(error) => error,
|
||
_ => panic!(),
|
||
};
|
||
assert_eq!(message, "Required attribute 'sid' missing.");
|
||
}
|
||
|
||
#[test]
|
||
fn test_invalid_stanza() {
|
||
let elem: Element = "<open xmlns='http://jabber.org/protocol/ibb' block-size='128' sid='coucou' stanza='fdsq'/>".parse().unwrap();
|
||
let error = Open::try_from(elem).unwrap_err();
|
||
let message = match error {
|
||
Error::ParseError(string) => string,
|
||
_ => panic!(),
|
||
};
|
||
assert_eq!(message, "Unknown value for 'stanza' attribute.");
|
||
}
|
||
}
|