Skip to main content

Document

Struct Document

pub struct Document {
    pub root: Tag,
    pub xml_decl_attrs: Vec<(String, String)>,
    pub doctype: Option<String>,
}

Expand description

An XML document with metadata.

§Example

use inline_xml::*;

fn main() {
    let xml = xml! {
        <html>
            <h1>Example Document</h1>
            <p>"This is an example document."</p>
        </html>
    };

    let doc = xml
        .into_document()
        .expect("Failed to create XML document.")
        .with_xml_version("1.0")
        .with_xml_encoding("UTF-8")
        .with_xml_attr("standalone", "yes")
        .with_doctype("html");

    println!("{doc}");
}

Fields§

§root: Tag§xml_decl_attrs: Vec<(String, String)>§doctype: Option<String>

Implementations§

impl Document

pub fn with_xml_attr(self, name: &str, value: impl Into<String>) -> Self

Pass an XML attribute.

§Example

use inline_xml::*;

let doc = xml! { <root /> }
    .into_document()
    .expect("Failed to create XML document.")
    .with_xml_attr("standalone", "yes");

pub fn with_xml_version(self, version: impl Into<String>) -> Self

Specify the XML version of this document.

pub fn with_xml_encoding(self, encoding: impl Into<String>) -> Self

Specify the XML encoding of this document (probably “UTF-8”).

pub fn with_doctype(self, doctype: impl Into<String>) -> Self

Specify the document type (eg. “html”).

Trait Implementations§

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Document

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

Formats the value using the given formatter. Read more

impl Display for Document

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

Formats the value using the given formatter. Read more

impl Eq for Document

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for Document

Auto Trait Implementations§

impl Freeze for Document

impl RefUnwindSafe for Document

impl Send for Document

impl Sync for Document

impl Unpin for Document

impl UnsafeUnpin for Document

impl UnwindSafe for Document

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.