Struct dae_parser::Document

pub struct Document {
    pub asset: Asset,
    pub library: Vec<LibraryElement>,
    pub scene: Option<Scene>,
    pub extra: Vec<Extra>,
}

A Collada document. Represents the <COLLADA> root node.

This is the main entry point for parsing.

Fields

asset: Asset

Metadata about the origin of the document

library: Vec<LibraryElement>

The main content, organized into a list of “libraries”.

scene: Option<Scene>

The actual scene being described, which references / instantiates objects in the libraries.

extra: Vec<Extra>

Provides arbitrary additional information about this element.

Implementations

impl Document

pub fn library_iter<T>(&self) -> LibraryIter<'_, T>

Returns an iterator over Library<T> elements.

pub fn iter<T>(&self) -> ItemIter<'_, T>

Returns an iterator over all elements of type T.

impl Document

pub fn try_for_each<'a, T: Traversable + 'a, E, F: FnMut(&'a T) -> Result<(), E>>(
    &'a self,
    f: F
) -> Result<(), E>

Run a function over all elements of type T in the document.

pub fn for_each<'a, T: Traversable + 'a>(&'a self, f: impl FnMut(&'a T))

Run a function over all elements of type T in the document.

pub fn local_map<T: Traversable + HasId>(
    &self
) -> Result<LocalMap<'_, T>, Error>

Construct an ID -> element mapping for node type T. This can be used to look up ID references.

pub fn get_visual_scene(&self) -> Option<&VisualScene>

Convenience function, to return the main VisualScene referred to in the scene field.

impl Document

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Constructs a Document from a file.

pub fn from_reader<R: BufRead>(reader: R) -> Result<Self, Error>

Constructs a Document from any BufRead reader. Use BufReader to construct a BufRead if you only have a Read instance.

pub fn from_xml_reader<R: BufRead>(
    reader: &mut Reader<R>
) -> Result<Self, Error>

Constructs a Document from a quick_xml::Reader.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl FromStr for Document

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

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

impl TryFrom<&'_ [u8]> for Document

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &[u8]) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&'_ str> for Document

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Error>

Performs the conversion.

impl XNode for Document

fn parse(element: &Element) -> Result<Self, Error>

Parse a Document from a <COLLADA> Element.

const NAME: &'static str

The name of the XML element.

fn parse_box(element: &Element) -> Result<Box<Self>, Error>

Parse an XML element and return the data structure in a Box. This can be faster in some cases when the data structure is large.

fn parse_one<'a>(
    it: &mut impl Iterator<Item = &'a Element>
) -> Result<Self, Error>

Parse a single required element from the given element iterator.

fn parse_opt(it: &mut Peekable<Children<'_>>) -> Result<Option<Self>, Error>

Parse an optional element from the given element iterator, using Self::NAME to determine if it is the correct type.

fn parse_opt_box(
    it: &mut Peekable<Children<'_>>
) -> Result<Option<Box<Self>>, Error>

Parse an optional boxed element from the given element iterator, using Self::NAME to determine if it is the correct type.

fn parse_list(it: &mut Peekable<Children<'_>>) -> Result<Vec<Self>, Error>

Parse a list of elements from the given element iterator, as long as it continues yielding elements of name Self::NAME.

fn parse_list_n<const N: usize>(
    it: &mut Peekable<Children<'_>>
) -> Result<Vec<Self>, Error>

Parse a list of elements from the given element iterator, as long as it continues yielding elements of name Self::NAME, and assert that the resulting list has length at least N.