pub struct SharedPropertyBag(/* private fields */);
Expand description

A wrapper of PropertyBag that can be safely shared across threads and cheaply cloned.

To access properties, use either acquire or acquire_mut. This can be one line for single property accesses, for example:

let my_string = properties.acquire().get::<String>();

For multiple accesses, the acquire result should be stored as a local since calling acquire repeatedly will be slower than calling it once:

let props = properties.acquire();
let my_string = props.get::<String>();
let my_vec = props.get::<Vec<String>>();

Use acquire_mut to insert properties into the bag:

properties.acquire_mut().insert("example".to_string());

Implementations§

source§

impl SharedPropertyBag

source

pub fn new() -> Self

Create an empty SharedPropertyBag.

source

pub fn acquire(&self) -> impl Deref<Target = PropertyBag> + '_

Acquire an immutable reference to the property bag.

source

pub fn acquire_mut(&self) -> impl DerefMut<Target = PropertyBag> + '_

Acquire a mutable reference to the property bag.

Trait Implementations§

source§

impl Clone for SharedPropertyBag

source§

fn clone(&self) -> SharedPropertyBag

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 SharedPropertyBag

source§

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

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

impl Default for SharedPropertyBag

source§

fn default() -> SharedPropertyBag

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

impl From<PropertyBag> for SharedPropertyBag

source§

fn from(bag: PropertyBag) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere 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, U> TryFrom<U> for Twhere 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 Twhere 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.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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