Struct bones_schema::ptr::SBox

pub struct SBox<T: HasSchema> { /* private fields */ }

A typed version of SchemaBox.

This allows to use SBox<T> extremely similar to a Box<T> except that it can be converted to and from a SchemaBox for compatibility with the schema ecosystem.

Also, compared to a SchemaBox, it is more efficient to access, because it avoids extra runtime checks for a matching schema after it has been created, and doesn’t need to be cast to T upon every access.

Implementations

impl<T: HasSchema> SBox<T>

pub fn new(value: T) -> Self

Create a new SBox.

pub fn into_schema_box(self) -> SchemaBox

Convert into a SchemaBox

Trait Implementations

impl<T: HasSchema> Clone for SBox<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: HasSchema + Debug> Debug for SBox<T>

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

Formats the value using the given formatter.

impl<T: HasSchema> Default for SBox<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: HasSchema> Deref for SBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: HasSchema> DerefMut for SBox<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<T: HasSchema> HasSchema for SBox<T>

fn schema() -> &'static Schema

Get this type’s Schema.

fn register_schema()

Register this schema with the global schema registry.

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

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

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

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

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

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

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

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

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

type Error = SchemaBox

The type returned in the event of a conversion error.

fn try_from(value: SchemaBox) -> Result<Self, Self::Error>

Performs the conversion.