xmpp-rs/parsers/src/oob.rs
Jonas Schäfer 6ef8dbefa3 parsers: use Error type from xso
This is a large change and as such, it needs good motivation. Let me
remind you of the ultimate goal: we want a derive macro which allows us
to FromXml/IntoXml, and that derive macro should be usable from
`xmpp_parsers` and other crates.

For that, any code generated by the derive macro mustn't depend on any
code in the `xmpp_parsers` crate, because you cannot name the crate you
are in portably (`xmpp_parsers::..` wouldn't resolve within
`xmpp_parsers`, and `crate::..` would point at other crates if the macro
was used in other crates).

We also want to interoperate with code already implementing
`TryFrom<Element>` and `Into<Element>` on structs. This ultimately
requires that we have an error type which is shared by the two
implementations and that error type must be declared in the `xso` crate
to be usable by the macros.

Thus, we port the error type over to use the type declared in `xso`.

This changes the structure of the error type greatly; I do not think
that `xso` should have to know about all the different types we are
parsing there and they don't deserve special treatment. Wrapping them in
a `Box<dyn ..>` seems more appropriate.
2024-06-23 09:40:52 +02:00

67 lines
1.8 KiB
Rust

// Copyright (c) 2024 Paul Fariello <xmpp-parsers@fariello.eu>
//
// 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/.
use crate::message::MessagePayload;
generate_element!(
/// Defines associated out of band url.
Oob, "x", OOB,
children: [
/// The associated URL.
url: Required<String> = ("url", OOB) => String,
/// An optionnal description of the out of band data.
desc: Option<String> = ("desc", OOB) => String,
]
);
impl MessagePayload for Oob {}
#[cfg(test)]
mod tests {
use super::*;
use crate::Element;
use xso::error::{Error, FromElementError};
#[cfg(target_pointer_width = "32")]
#[test]
fn test_size() {
assert_size!(Oob, 24);
}
#[cfg(target_pointer_width = "64")]
#[test]
fn test_size() {
assert_size!(Oob, 48);
}
#[test]
fn test_simple() {
let elem: Element = "<x xmlns='jabber:x:oob'><url>http://example.org</url></x>"
.parse()
.unwrap();
Oob::try_from(elem).unwrap();
}
#[test]
fn test_with_desc() {
let elem: Element =
"<x xmlns='jabber:x:oob'><url>http://example.org</url><desc>Example website</desc></x>"
.parse()
.unwrap();
Oob::try_from(elem).unwrap();
}
#[test]
fn test_invalid_child() {
let elem: Element = "<x xmlns='jabber:x:oob'></x>".parse().unwrap();
let error = Oob::try_from(elem).unwrap_err();
let message = match error {
FromElementError::Invalid(Error::Other(string)) => string,
_ => panic!(),
};
assert_eq!(message, "Missing child url in x element.");
}
}