xso: document some specific trait implementations

This commit is contained in:
Jonas Schäfer 2024-08-10 09:34:05 +02:00
commit ad2c79cbe7
2 changed files with 10 additions and 0 deletions

View file

@ -26,6 +26,12 @@ impl<T: FromEventsBuilder> FromEventsBuilder for OptionBuilder<T> {
}
}
/// Parsers `T` into `Some(.)`.
///
/// Note that this never generates `None`: The main use case is to allow
/// external (i.e. without calling `from_events`) defaulting to `None` and
/// for optional serialisation (the [`AsXml`][`crate::AsXml`] implementation
/// on `Option<T>` emits nothing for `None`).
impl<T: FromXml> FromXml for Option<T> {
type Builder = OptionBuilder<T::Builder>;
@ -48,6 +54,7 @@ impl<T: FromEventsBuilder> FromEventsBuilder for BoxBuilder<T> {
}
}
/// Parsers `T` into a `Box`.
impl<T: FromXml> FromXml for Box<T> {
type Builder = BoxBuilder<T::Builder>;