Struct gltf_json::Index

pub struct Index<T>(/* private fields */);

Represents an offset into a vector of type T owned by the root glTF object.

This type may be used with the following functions:

• Root::get() to retrieve objects from Root.
• Root::push() to add new objects to Root.

Implementations

impl<T> Index<T>

pub fn push(vec: &mut Vec<T>, value: T) -> Index<T>

Given a vector of glTF objects, call Vec::push() to insert it into the vector, then return an Index for it.

This allows you to easily obtain Index values with the correct index and type when creating a glTF asset. Note that for Root, you can call Root::push() without needing to retrieve the correct vector first.

Panics

Panics if the vector has u32::MAX or more elements, in which case an Index cannot be created.

impl<T> Index<T>

pub fn new(value: u32) -> Self

Creates a new Index representing an offset into an array containing T.

pub fn value(&self) -> usize

Returns the internal offset value.

Trait Implementations

impl<T> Clone for Index<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Index<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Index<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Index<T>

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

Formats the value using the given formatter.

impl<T> Hash for Index<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Index<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for Index<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for Index<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Index<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Validate> Validate for Index<T>

where Root: Get<T>,

fn validate<P, R>(&self, root: &Root, path: P, report: &mut R)

where P: Fn() -> Path, R: FnMut(&dyn Fn() -> Path, Error),

Validates the invariants required for the library to function safely.

impl<T> Copy for Index<T>

impl<T> Eq for Index<T>