Struct bones_framework :: prelude :: bones_schema :: alloc :: SchemaMap Copy item path

impl SchemaMap

pub fn new( key_schema: &'static Schema, value_schema: &'static Schema, ) -> SchemaMap

Create a new map, with the given key and value schemas.

pub fn len(&self) -> usize

Get the number of entries in the map.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

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

Get the schema for the map keys.

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

Get the schema for the map values.

pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<V>
where K: HasSchema, V: HasSchema,

Insert an item into the map.

§Panics

Panics if the key or value schemas do not match the map’s.

pub fn try_insert<K, V>( &mut self, key: K, value: V, ) -> Result<Option<V>, SchemaMismatchError>
where K: HasSchema, V: HasSchema,

Insert an item into the map.

§Errors

Errors if the key or value schemas do not match the map’s.

pub fn insert_box( &mut self, key: SchemaBox, value: SchemaBox, ) -> Option<SchemaBox>

Insert an untyped item into the map.

§Panics

Panics if the key or value schemas do not match the map’s.

pub fn try_insert_box( &mut self, key: SchemaBox, value: SchemaBox, ) -> Result<Option<SchemaBox>, SchemaMismatchError>

Insert an untyped item into the map.

§Errors

Errors if the key or value schemas do not match the map’s.

pub unsafe fn insert_box_unchecked( &mut self, key: SchemaBox, value: SchemaBox, ) -> Option<SchemaBox>

§Safety

Key schema and value schema must match the map’s.

pub fn get<K, V>(&self, key: &K) -> Option<&V>
where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

§Panics

Panics if the schemas of the key and value don’t match the schemas of the map.

pub fn try_get<K, V>(&self, key: &K) -> Result<Option<&V>, SchemaMismatchError>
where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

§Errors

Errors if the schemas of the key and value don’t match the schemas of the map.

pub fn get_ref(&self, key: SchemaRef<'_>) -> Option<SchemaRef<'_>>

Get an untyped reference to an item in the map.

§Panics

Panics if the schema of the key doesn’t match.

pub fn try_get_ref( &self, key: SchemaRef<'_>, ) -> Result<Option<SchemaRef<'_>>, SchemaMismatchError>

Get an untyped reference to an item in the map.

§Errors

Errors if the schema of the key doesn’t match.

pub unsafe fn get_ref_unchecked( &self, key: SchemaRef<'_>, ) -> Option<SchemaRef<'_>>

§Safety

The key’s schema must match this map’s key schema.

pub fn get_ref_mut(&mut self, key: SchemaRef<'_>) -> Option<SchemaRefMut<'_>>

Get an untyped reference to an item in the map.

§Panics

Panics if the schema of the key doesn’t match.

pub fn try_get_ref_mut( &mut self, key: SchemaRef<'_>, ) -> Result<Option<SchemaRefMut<'_>>, SchemaMismatchError>

Get an untyped reference to an item in the map.

§Errors

Errors if the schema of the key doesn’t match.

pub unsafe fn get_ref_unchecked_mut( &mut self, key: SchemaRef<'_>, ) -> Option<SchemaRefMut<'_>>

§Safety

The key’s schema must match this map’s key schema.

pub fn get_mut<K, V>(&mut self, key: &K) -> Option<&mut V>
where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

§Panics

Panics if the schemas of the key and value don’t match the schemas of the map.

pub fn try_get_mut<K, V>( &mut self, key: &K, ) -> Result<Option<&mut V>, SchemaMismatchError>
where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

§Errors

Errors if the schemas of the key and value don’t match the schemas of the map.

pub fn remove<K, V>(&mut self, key: &K) -> Option<V>
where K: HasSchema, V: HasSchema,

Remove an item.

§Panics

Panics if the schemas of the key and value don’t match the map.

pub fn try_remove<K, V>( &mut self, key: &K, ) -> Result<Option<V>, SchemaMismatchError>
where K: HasSchema, V: HasSchema,

Remove an item.

§Errors

Errors if the schemas of the key and value don’t match the map.

pub fn remove_box(&mut self, key: SchemaRef<'_>) -> Option<SchemaBox>

Untypededly remove an item.

§Panics

Panics if the key schema does not match the map’s.

pub fn try_remove_box( &mut self, key: SchemaRef<'_>, ) -> Result<Option<SchemaBox>, SchemaMismatchError>

Untypededly remove an item.

§Errors

Errors if the key schema does not match the map’s.

pub unsafe fn remove_unchecked( &mut self, key: SchemaRef<'_>, ) -> Option<SchemaBox>

§Safety

The key schema must match the map’s.

pub fn into_smap<K, V>(self) -> SMap<K, V>
where K: HasSchema, V: HasSchema,

Convert into a typed SMap.

§Panics

Panics if the schemas of K and V don’t match the SchemaMap.

pub fn try_into_smap<K, V>(self) -> Result<SMap<K, V>, SchemaMismatchError>
where K: HasSchema, V: HasSchema,

Convert into a typed SMap.

§Errors

Errors if the schemas of K and V don’t match the SchemaMap.

impl SchemaMap

pub fn iter( &self, ) -> Map<Iter<'_, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a SchemaBox)) -> (SchemaRef<'a>, SchemaRef<'a>)> ⓘ

Iterate over entries in the map.

pub fn iter_mut( &mut self, ) -> Map<IterMut<'_, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a mut SchemaBox)) -> (SchemaRef<'a>, SchemaRefMut<'a>)> ⓘ

Iterate over entries in the map.

pub fn keys( &self, ) -> Map<Keys<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a SchemaBox) -> SchemaRef<'a>> ⓘ

Iterate over keys in the map.

pub fn values( &self, ) -> Map<Values<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a SchemaBox) -> SchemaRef<'a>> ⓘ

Iterate over values in the map.

pub fn values_mut( &mut self, ) -> Map<ValuesMut<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a mut SchemaBox) -> SchemaRefMut<'a>> ⓘ

Iterate over values in the map.

Trait Implementations§

impl Clone for SchemaMap

fn clone(&self) -> SchemaMap

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 SchemaMap

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

Formats the value using the given formatter. Read more

impl<'a> IntoIterator for &'a SchemaMap

type Item = (SchemaRef<'a>, SchemaRef<'a>)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a SchemaBox)) -> (SchemaRef<'a>, SchemaRef<'a>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a SchemaMap as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl<'a> IntoIterator for &'a mut SchemaMap

type Item = (SchemaRef<'a>, SchemaRefMut<'a>)

The type of the elements being iterated over.

type IntoIter = Map<IterMut<'a, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a mut SchemaBox)) -> (SchemaRef<'a>, SchemaRefMut<'a>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut SchemaMap as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

impl !UnwindSafe for SchemaMap

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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<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> 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> 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> Same for T

type Output = T

Should always be Self

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<T, U> ToSample for T
where U: FromSample<T>,

fn to_sample_(self) -> U

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