path: root/src/lib.rs

//! # peanuts: An ergonomic (async) xml reader/writer library.
//!
//! Features:
//!
//! - Serialisation
//! - Deserialisation
//! - DOM navigation
//! - Namespacing
//! - Websocket framing

/// XML prolog declaration types.
pub mod declaration;
mod element;
mod error;
mod reader;
mod writer;
// TODO: alternative raw xml API
mod xml;

/// Result type for the crate.
pub type Result<T> = std::result::Result<T, error::Error>;

/// XML namespace URI for the `xml:` namespace prefix.
pub const XML_NS: &str = "http://www.w3.org/XML/1998/namespace";
/// XML namespace URI for the `xmlns:` namespace prefix.
pub const XMLNS_NS: &str = "http://www.w3.org/2000/xmlns/";

pub use element::Content;
pub use element::ContentBuilder;
pub use element::DeserializeResult;
pub use element::Element;
pub use element::ElementBuilder;
pub use element::FromContent;
pub use element::FromElement;
pub use element::IntoContent;
pub use element::IntoElement;
pub use error::DeserializeError;
pub use error::Error;
pub use reader::Reader;
pub use writer::Loggable;
pub use writer::Writer;