Document

Struct Document 

Source
pub struct Document { /* private fields */ }

Implementations§

Source§

impl Document

Source

pub fn new(root: impl Into<NewElement>) -> Self

Create a new document with the specified element as root.

See NewElement for what root accepts.

assert_eq!(
    xmlem::Document::new("root").to_string(),
    r#"<root/>"#,
);
assert_eq!(
    xmlem::Document::new(("a", [("b", "c")])).to_string(),
    r#"<a b="c"/>"#,
);
§Panics

This method panics if root contains non-representable element or attribute names.

Source

pub fn sort(&mut self, elements: bool)

Source

pub fn set_declaration(&mut self, decl: Option<Declaration>)

Examples found in repository?
examples/readme.rs (line 18)
5fn main() {
6    let mut doc = Document::from_str("<root><potato /></root>").unwrap();
7    let root = doc.root();
8
9    let potato = root
10        .query_selector(&doc, &Selector::new("potato").unwrap())
11        .unwrap();
12    potato.append_new_element(
13        &mut doc,
14        ("wow", [("easy", "true"), ("x", "200"), ("a-null", "\0")]),
15    );
16
17    let decl = Declaration::v1_1();
18    doc.set_declaration(Some(decl));
19    doc.set_doctype(Some("not-html"));
20
21    println!("{}", doc.to_string_pretty());
22}
Source

pub fn declaration(&self) -> Option<&Declaration>

Source

pub fn set_doctype(&mut self, doctype: Option<&str>)

Examples found in repository?
examples/readme.rs (line 19)
5fn main() {
6    let mut doc = Document::from_str("<root><potato /></root>").unwrap();
7    let root = doc.root();
8
9    let potato = root
10        .query_selector(&doc, &Selector::new("potato").unwrap())
11        .unwrap();
12    potato.append_new_element(
13        &mut doc,
14        ("wow", [("easy", "true"), ("x", "200"), ("a-null", "\0")]),
15    );
16
17    let decl = Declaration::v1_1();
18    doc.set_declaration(Some(decl));
19    doc.set_doctype(Some("not-html"));
20
21    println!("{}", doc.to_string_pretty());
22}
Source

pub fn doctype(&self) -> Option<&str>

Source

pub fn root(&self) -> Element

Examples found in repository?
examples/readme.rs (line 7)
5fn main() {
6    let mut doc = Document::from_str("<root><potato /></root>").unwrap();
7    let root = doc.root();
8
9    let potato = root
10        .query_selector(&doc, &Selector::new("potato").unwrap())
11        .unwrap();
12    potato.append_new_element(
13        &mut doc,
14        ("wow", [("easy", "true"), ("x", "200"), ("a-null", "\0")]),
15    );
16
17    let decl = Declaration::v1_1();
18    doc.set_declaration(Some(decl));
19    doc.set_doctype(Some("not-html"));
20
21    println!("{}", doc.to_string_pretty());
22}
Source

pub fn to_string_pretty(&self) -> String

Examples found in repository?
examples/readme.rs (line 21)
5fn main() {
6    let mut doc = Document::from_str("<root><potato /></root>").unwrap();
7    let root = doc.root();
8
9    let potato = root
10        .query_selector(&doc, &Selector::new("potato").unwrap())
11        .unwrap();
12    potato.append_new_element(
13        &mut doc,
14        ("wow", [("easy", "true"), ("x", "200"), ("a-null", "\0")]),
15    );
16
17    let decl = Declaration::v1_1();
18    doc.set_declaration(Some(decl));
19    doc.set_doctype(Some("not-html"));
20
21    println!("{}", doc.to_string_pretty());
22}
Source

pub fn to_string_pretty_with_config(&self, config: &Config) -> String

Source

pub fn from_file(file: File) -> Result<Document, ReadError>

Source

pub fn from_reader<R: BufRead>(reader: R) -> Result<Document, ReadError>

Trait Implementations§

Source§

impl Clone for Document

Source§

fn clone(&self) -> Document

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Document

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for Document

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromStr for Document

Source§

type Err = ReadError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Document, ReadError>

Parses a string s to return a value of this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more