Struct bones_lib::ecs::prelude::SchemaRef

source ·
pub struct SchemaRef<'pointer> { /* private fields */ }
Expand description

An untyped reference that knows the [Schema] of the pointee and that can be cast to a matching type.

Implementations§

source§

impl<'pointer> SchemaRef<'pointer>

source

pub unsafe fn cast_unchecked<T>(&self) -> &T

Unsafely cast this pointer to a specifc Rust type.

§Safety

All of the safety requirements of NonNull::as_ref() must be met.

source

pub unsafe fn cast_into_unchecked<T>(self) -> &'pointer T

Unsafely cast this pointer to a specifc Rust type.

§Safety

All of the safety requirements of NonNull::as_ref() must be met.

source

pub fn cast<T>(&self) -> &'pointer T
where T: HasSchema,

Cast this pointer to a reference to a type with a matching [Schema].

§Panics

Panics if the schema of the pointer does not match that of the type you are casting to.

source

pub fn try_cast<T>(&self) -> Result<&'pointer T, SchemaMismatchError>
where T: HasSchema,

Cast this pointer to a reference to a type with a matching [Schema].

§Errors

Errors if the schema of the pointer does not match that of the type you are casting to.

source

pub fn new<T>(v: &'pointer T) -> SchemaRef<'pointer>
where T: HasSchema,

Create a new SchemaRef from a reference to a type that implements HasSchema.

source

pub unsafe fn from_ptr_schema( ptr: *const c_void, schema: &'static Schema, ) -> SchemaRef<'pointer>

Create a new SchemaRef from a raw pointer and it’s schema.

§Safety
  • The pointee of ptr must be accurately described by the given schema.
  • inner must have correct provenance to allow read of the pointee type.
  • The pointer must be valid for the full lifetime of this SchemaRef.
source

pub fn as_ptr(&self) -> *const c_void

Get the pointer.

source

pub fn schema(&self) -> &'static Schema

Get the [Schema] for the pointer.

source

pub fn hash(&self) -> Option<u64>

Get the hash of this schema box, if supported.

source

pub fn as_map(&self) -> Option<&'pointer SchemaMap>

Borrow the schema ref as a SchemaMap if it is one.

source

pub fn as_vec(&self) -> Option<&'pointer SchemaVec>

Borrow the schema ref as a SchemaVec if it is one.

source

pub fn as_box(&self) -> Option<SchemaRef<'pointer>>

Borrow the schema ref as a SchemaBox if it is one.

source

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

Debug format the value stored in the schema box.

This is used in the display and debug implementations.

source

pub fn access(self) -> SchemaRefAccess<'pointer>

Get a helper to access the inner data.

source

pub fn field<'a, I>(self, field_idx: I) -> Option<SchemaRef<'pointer>>
where I: Into<FieldIdx<'a>>,

Get the reference to a field.

source

pub fn field_path<'a, I>(self, path: I) -> Option<SchemaRef<'pointer>>
where I: IntoIterator<Item = FieldIdx<'a>>,

Get the field pointed to by the given path.

source

pub fn clone_into_box(&self) -> SchemaBox

Clone this schema ref into a new box.

Trait Implementations§

source§

impl<'pointer> Clone for SchemaRef<'pointer>

source§

fn clone(&self) -> SchemaRef<'pointer>

Returns a copy 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 SchemaRef<'_>

source§

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

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

impl Display for SchemaRef<'_>

source§

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

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

impl<'a> From<SchemaRef<'a>> for PrimitiveRef<'a>

source§

fn from(value: SchemaRef<'a>) -> PrimitiveRef<'a>

Converts to this type from the input type.
source§

impl<'pointer> Copy for SchemaRef<'pointer>

Auto Trait Implementations§

§

impl<'pointer> Freeze for SchemaRef<'pointer>

§

impl<'pointer> !RefUnwindSafe for SchemaRef<'pointer>

§

impl<'pointer> !Send for SchemaRef<'pointer>

§

impl<'pointer> !Sync for SchemaRef<'pointer>

§

impl<'pointer> Unpin for SchemaRef<'pointer>

§

impl<'pointer> !UnwindSafe for SchemaRef<'pointer>

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: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> RawClone for T
where T: Clone,

source§

unsafe fn raw_clone(src: *const c_void, dst: *mut c_void)

Write the default value of the type to the pointer. Read more
source§

fn raw_clone_cb() -> Unsafe<&'static (dyn Fn(*const c_void, *mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T> RawDrop for T

source§

unsafe fn raw_drop(ptr: *mut c_void)

Write the default value of the type to the pointer. Read more
source§

fn raw_drop_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T> ToOwned for T
where T: Clone,

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V