Skip to main content

CrateData

Struct CrateData 

Source
pub struct CrateData<R> { /* private fields */ }
Expand description

High level interface to binary data.

Implementations§

Source§

impl<R> CrateData<R>
where R: Read + Seek,

Source

pub fn open(reader: R, safe: bool) -> Result<Self>

Read binary data from any reader.

Trait Implementations§

Source§

impl<R> AbstractData for CrateData<R>
where R: Read + Seek,

Source§

fn has_spec(&self, path: &Path) -> bool

Returns true if this data has a spec for the given path.
Source§

fn has_field(&self, path: &Path, field: &str) -> bool

Returns true if this data has a field for the given path.
Source§

fn spec_type(&self, path: &Path) -> Option<SpecType>

Returns the type of the spec at the given path.
Source§

fn try_field( &self, path: &Path, field: &str, ) -> Result<Option<Cow<'_, Value>>, DataError>

Returns the value for a field, or None if not authored. Read more
Source§

fn list_fields(&self, path: &Path) -> Option<Vec<String>>

Returns the field names for a given path in authored order.
Source§

fn spec_paths(&self) -> Vec<Path>

Returns every authored path, sorted lexicographically. Read more
Source§

fn create_spec(&mut self, path: Path, ty: SpecType)

Creates an empty spec of type ty at path, replacing any existing spec there. Mirrors C++ SdfAbstractData::CreateSpec. Fields are authored separately via set_field.
Source§

fn erase_spec(&mut self, path: &Path)

Removes the spec at path along with all its fields. Mirrors C++ SdfAbstractData::EraseSpec. No-op if no spec exists there.
Source§

fn set_field(&mut self, path: &Path, field: &str, value: Value)

Sets (or replaces) field on the spec at path, preserving authored field order. Mirrors C++ SdfAbstractData::Set. The spec must already exist (create it with create_spec first); setting a field on an absent spec drops the write (debug builds assert). Read more
Source§

fn erase_field(&mut self, path: &Path, field: &str)

Removes field from the spec at path. Mirrors C++ SdfAbstractData::EraseField. No-op if the spec or field is absent.
Source§

fn get_field( &self, path: &Path, field: &str, ) -> Result<Cow<'_, Value>, DataError>

Returns the value for a field, erroring if not authored. Read more

Auto Trait Implementations§

§

impl<R> !Freeze for CrateData<R>

§

impl<R> !RefUnwindSafe for CrateData<R>

§

impl<R> !Sync for CrateData<R>

§

impl<R> Send for CrateData<R>
where R: Send,

§

impl<R> Unpin for CrateData<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for CrateData<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for CrateData<R>
where R: UnwindSafe,

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