Struct bones_framework :: prelude :: SchemaBox Copy item path

impl SchemaBox

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

Get a raw pointer to the box data.

pub fn cast_into<T>(self) -> T
where T: HasSchema,

Cast this box to it’s inner type and return it.

§Panics

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

pub fn try_cast_into<T>(self) -> Result<T, SchemaMismatchError>
where T: HasSchema,

Cast this box to it’s inner type and return it.

§Errors

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

pub unsafe fn cast_into_unchecked<T>(self) -> T
where T: HasSchema,

Unsafely convert this box into an owned T.

§Safety

The schema of type T must equal that of this box.

pub fn cast_ref<T>(&self) -> &T
where T: HasSchema,

Cast this box to a reference to a type with a representative [Schema].

§Panics

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

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

Cast this box to a reference to a type with a representative [Schema].

§Errors

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

pub fn cast_mut<T>(&mut self) -> &mut T
where T: HasSchema,

Cast this box to a mutable reference to a type with a representing [Schema].

§Panics

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

pub fn try_cast_mut<T>(&mut self) -> Result<&mut T, SchemaMismatchError>
where T: HasSchema,

Cast this box to a mutable reference to a type with a representing [Schema].

§Errors

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

pub fn as_ref(&self) -> SchemaRef<'_>

Borrow this box as a SchemaRef.

pub fn as_mut(&mut self) -> SchemaRefMut<'_>

Borrow this box as a SchemaRefMut.

pub fn new<T>(v: T) -> SchemaBox
where T: HasSchema + Sync + Send,

Create a new SchemaBox from an owned type.

pub unsafe fn uninitialized(schema: &'static Schema) -> SchemaBox

Allocates a SchemaBox for the given [Schema], but doesn’t initialize the memory.

§Safety

Accessing the data in an unitinialized SchemaBox is undefined behavior. It is up to the user to initialize the memory pointed at by the box after creating it.

pub fn default(schema: &'static Schema) -> SchemaBox

Create a new SchemaBox for a type with a [Schema] that has a SchemaData::default_fn.

§Panics

Panics if the passed in schema doesn’t have a default_fn.

pub fn into_sbox<T>(self) -> SBox<T>
where T: HasSchema,

Convert into an SBox if the schema of T matches.

§Panics

Panics if the schema of T doesn’t match that of the box.

pub fn try_into_sbox<T>(self) -> Result<SBox<T>, SchemaBox>
where T: HasSchema,

Convert into an SBox if the schema of T matches.

§Errors

Returns an error with the orignal SchemaBox if the schema of T doesn’t match.

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

Get the [Schema] for the pointer.

pub unsafe fn from_raw_parts( ptr: NonNull<c_void>, schema: &'static Schema, ) -> SchemaBox

Create a new SchemaBox from raw parts.

This is useful for creating a SchemaBox for data with a schema loaded at runtime and without a Rust type.

§Safety

You must insure that the pointer is valid for the given schema.

pub fn forget(self)

Deallocate the memory stored in the box, but don’t run the destructor.

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

Get the hash of this schema box, if supported.

pub fn hash(&self) -> u64

Get the hash of this schema box.

§Panics

Panics if the schema doesn’t implement hash.

Trait Implementations§

impl Clone for SchemaBox

fn clone(&self) -> SchemaBox

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

impl Debug for SchemaBox

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

Formats the value using the given formatter. Read more

impl Default for SchemaBox

fn default() -> SchemaBox

Returns the “default value” for a type. Read more

impl Display for SchemaBox

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

Formats the value using the given formatter. Read more

impl Drop for SchemaBox

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<T> From<SBox<T>> for SchemaBox
where T: HasSchema,

fn from(value: SBox<T>) -> SchemaBox

Converts to this type from the input type.

impl HasSchema for SchemaBox

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry. Read more

fn cast<T>(this: &Self) -> &T
where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout. Read more

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>
where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout. Read more

fn cast_mut<T>(this: &mut Self) -> &mut T
where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout. Read more

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>
where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout. Read more

fn as_schema_ref(&self) -> SchemaRef<'_>
where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>
where Self: Sized,

Converts a reference of T to a SchemaRefMut

impl Hash for SchemaBox

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for SchemaBox

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

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

1.0.0 · source§

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> TryFrom<SchemaBox> for SBox<T>
where T: HasSchema,

type Error = SchemaBox

The type returned in the event of a conversion error.

fn try_from( value: SchemaBox, ) -> Result<SBox<T>, <SBox<T> as TryFrom<SchemaBox>>::Error>

Performs the conversion.

impl Eq for SchemaBox

impl Send for SchemaBox

impl Sync for SchemaBox

Auto Trait Implementations§

impl !UnwindSafe for SchemaBox

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyEq for T
where T: Any + PartialEq,

fn equals(&self, other: &(dyn Any + 'static)) -> bool

fn as_any(&self) -> &(dyn Any + 'static)

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

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

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> FromWorld for T
where T: Default,

fn from_world(_world: &World) -> T

Creates Self using data from the given World.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoArcAny for T
where T: Send + Sync + 'static,

fn into_arc_any(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Casts Arc<Self> into Arc<dyn Any + Send + Sync>.

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

fn into_sample(self) -> T

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

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

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

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

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

Get a callback suitable for [SchemaData].

impl<T> RawDefault for T
where T: Default,

unsafe fn raw_default(dst: *mut c_void)

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

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

Get a callback suitable for [SchemaData].

impl<T> RawDrop for T

unsafe fn raw_drop(ptr: *mut c_void)

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

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

Get a callback suitable for [SchemaData].

impl<T> RawEq for T
where T: Eq,

unsafe fn raw_eq(a: const c_void, b: const c_void) -> bool

Get the hash of the type. Read more

fn raw_eq_cb() -> Unsafe<&'static (dyn Fn(const c_void, const c_void) -> bool + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> RawHash for T
where T: Hash,

unsafe fn raw_hash(ptr: *const c_void) -> u64

Get the hash of the type. Read more

fn raw_hash_cb() -> Unsafe<&'static (dyn Fn(*const c_void) -> u64 + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> Same for T

type Output = T

Should always be Self

impl<'gc, T> Singleton<'gc> for T
where T: Default,

fn create(_: Context<'gc>) -> T

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<Q> ToOwnedEquivalent<<Q as ToOwned>::Owned> for Q
where Q: ToOwned + Eq + ?Sized,

fn to_owned_equivalent(&self) -> <Q as ToOwned>::Owned

impl<T, U> ToSample for T
where U: FromSample<T>,

fn to_sample_(self) -> U

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,