Skip to main content

OxiFile

Struct OxiFile 

Source
pub struct OxiFile {
    pub version: u32,
    pub root: Group,
}
Expand description

Root container for the OxiPhy binary file format.

Binary layout:

  • 8 bytes magic: OXIPHY01
  • 4 bytes version: u32 little-endian
  • Recursively serialized root group

Fields§

§version: u32§root: Group

Implementations§

Source§

impl OxiFile

Source

pub fn new() -> Self

Creates a new empty OxiFile at version 1.

Source

pub fn write_to_bytes(&self) -> Vec<u8>

Serializes the entire file to a byte vector.

Source

pub fn read_from_bytes(data: &[u8]) -> Result<Self, String>

Deserializes an OxiFile from a byte slice.

Source

pub fn save(&self, path: &str) -> Result<(), String>

Writes the file to disk at the given path.

Source

pub fn load(path: &str) -> Result<Self, String>

Loads an OxiFile from disk.

Source§

impl OxiFile

Source

pub fn with_version(version: FormatVersion) -> Self

Create an OxiFile at a specific format version.

Source

pub fn format_version(&self) -> Result<FormatVersion, String>

Return the parsed FormatVersion if recognised, else an error.

Source

pub fn add_binary_mesh(&mut self, group: &str, mesh: &BinaryMesh)

Store a BinaryMesh under the given group name.

Source

pub fn get_binary_mesh(&self, group: &str) -> Result<BinaryMesh, String>

Retrieve and decode a BinaryMesh from the given group.

Trait Implementations§

Source§

impl Clone for OxiFile

Source§

fn clone(&self) -> OxiFile

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 OxiFile

Source§

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

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

impl Default for OxiFile

Source§

fn default() -> Self

Returns the “default value” for a 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, 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.