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

xso: extend the documentation overall

Browse source 
Sprinkling it with examples, adding more words to make things
(hopefully) clearer, using a similar structure for different items etc.
etc.
This commit is contained in:
Jonas Schäfer 2025-04-27 13:41:58 +02:00
commit 341d49fecf
2 changed files with 159 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

8
xso/src/rxml_util.rs
View file

@ -10,9 +10,13 @@ use alloc::borrow::{Cow, ToOwned};
use rxml::{parser::EventMetrics, AttrMap, Event, Namespace, NcName, NcNameStr, XmlVersion};
/// An encodable item.
/// # Serialisable piece of XML
///
/// Unlike [`rxml::Item`], the contents of this item may either be owned or
/// This item represents a piece of an XML document which can be serialised
/// into bytes by converting it to an [`rxml::Item`] and then feeding it to a
/// [`rxml::Encoder`].
///
/// Unlike `rxml::Item`, the contents of this item may either be owned or
/// borrowed, individually. This enables the use in an [`crate::AsXml`] trait
/// even if data needs to be generated during serialisation.
#[derive(Debug)]