XDFFile

Struct XDFFile 

Source
pub struct XDFFile {
    pub version: f32,
    pub header: Element,
    pub streams: Vec<Stream>,
}
Expand description

XDF file struct The main struct representing an XDF file.

Fields§

§version: f32

XDF version. Currently only 1.0 exists according to the specification.

§header: Element

The XML header of the XDF file as an xmltree::Element.

§streams: Vec<Stream>

A vector of streams contained in the XDF file.

Implementations§

Source§

impl XDFFile

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, XDFError>

Parse an XDF file from a byte slice.

§Arguments
  • bytes - A byte slice of the whole XDF file as read from disk.
§Returns
  • A Result containing the parsed XDFFile or an [XDFError]
§Errors

Will error if the file could not be parsed correctly for various reasons. See [XDFError] for more information.

§Example
let bytes = fs::read("tests/minimal.xdf")?;
let xdf_file = XDFFile::from_bytes(&bytes)?;

Trait Implementations§

Source§

impl Clone for XDFFile

Source§

fn clone(&self) -> XDFFile

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 XDFFile

Source§

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

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

impl PartialEq for XDFFile

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for XDFFile

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, 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, 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.