xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

xso: fix some documentation in minidom_compat

Browse source
This commit is contained in:
Jonas Schäfer 2025-04-27 12:35:49 +02:00
commit 8688524e1a
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
xso/src/minidom_compat.rs
View file

@ -28,6 +28,8 @@ use crate::{
}; };
/// State machine for converting a minidom Element into rxml events. /// State machine for converting a minidom Element into rxml events.
///
/// See [`IntoEvents`] for when this is still used.
enum IntoEventsInner { enum IntoEventsInner {
/// Element header: the element is still intact and we need to generate /// Element header: the element is still intact and we need to generate
/// the [`rxml::Event::StartElement`] event from the namespace, name, and /// the [`rxml::Event::StartElement`] event from the namespace, name, and
@ -144,9 +146,10 @@ impl IntoEventsInner {
/// Convert a [`minidom::Element`] into [`rxml::Event`]s. /// Convert a [`minidom::Element`] into [`rxml::Event`]s.
/// ///
/// This can be constructed from the /// This is a helper struct for [`FromEventsViaElement`]. We cannot use
/// [`IntoXml::into_event_iter`][`crate::IntoXml::into_event_iter`] /// [`ElementAsXml`] there for lifetime reasons: The [`FromXml`] trait does
/// implementation on [`minidom::Element`]. /// not allow a lifetime parameter on the `Builder` type or passing arbitrary
/// data into the builder.
struct IntoEvents(IntoEventsInner); struct IntoEvents(IntoEventsInner);
impl IntoEvents { impl IntoEvents {
@ -183,7 +186,7 @@ enum AsXmlState<'a> {
/// Remaining child nodes (text and/or children) to emit. /// Remaining child nodes (text and/or children) to emit.
nodes: minidom::element::Nodes<'a>, nodes: minidom::element::Nodes<'a>,
/// When emitting a child element, this is a nested [`IntoEvents`] /// When emitting a child element, this is a nested [`ElementAsXml`]
/// instance for that child element. /// instance for that child element.
nested: Option<Box<ElementAsXml<'a>>>, nested: Option<Box<ElementAsXml<'a>>>,
}, },