Skip to main content

Extensions

Struct Extensions 

Source
pub struct Extensions { /* private fields */ }
Expand description

A type-keyed map of opaque Arc’d values. Each Rust type T occupies its own slot, so independent components can each attach their own data without conflict.

Cloning is cheap: the backing values are reference-counted.

§Example

struct MyData(u32);
struct OtherData(&'static str);

let mut ext = Extensions::new();
ext.insert(MyData(42));
ext.insert_arc(Arc::new(OtherData("hello")));

assert_eq!(ext.get::<MyData>().unwrap().0, 42);
assert_eq!(ext.get::<OtherData>().unwrap().0, "hello");

Implementations§

Source§

impl Extensions

Source

pub fn new() -> Self

Create an empty map.

Source

pub fn is_empty(&self) -> bool

Returns true if no extensions are set.

Source

pub fn len(&self) -> usize

Number of extensions set.

Source

pub fn insert<T: Any + Send + Sync>(&mut self, value: T) -> Option<Arc<T>>

Insert an extension keyed by its concrete type T. Returns the previous value of that type, if any.

The value is wrapped in an Arc internally. If the caller already has an Arc<T> and wants to avoid an extra allocation, use Self::insert_arc.

Source

pub fn insert_arc<T: Any + Send + Sync>( &mut self, value: Arc<T>, ) -> Option<Arc<T>>

Insert an extension keyed by its concrete type T, taking an already-allocated Arc<T>. Returns the previous value of that type, if any.

Source

pub fn insert_dyn( &mut self, value: Arc<dyn Any + Send + Sync>, ) -> Option<Arc<dyn Any + Send + Sync>>

👎Deprecated since 54.0.0:

use insert or insert_arc; only retained to support the deprecated PartitionedFile::with_extensions shim

Insert an already-type-erased value, keyed by its dynamic TypeId. Used internally to support APIs that accept Arc<dyn Any + Send + Sync> for backwards compatibility and need to recover the concrete type for keying.

New code should use Self::insert or Self::insert_arc, which preserve the concrete type at the call site.

Source

pub fn get<T: Any + Send + Sync>(&self) -> Option<&T>

Borrow the extension of type T, if set.

Source

pub fn get_arc<T: Any + Send + Sync>(&self) -> Option<Arc<T>>

Get a cloned Arc<T> of the extension, if set.

Source

pub fn contains<T: Any + Send + Sync>(&self) -> bool

Returns true if an extension of type T is set.

Source

pub fn merge(&mut self, other: &Extensions)

Merge entries from other into self. Entries in other take precedence over existing entries with the same type.

Trait Implementations§

Source§

impl Clone for Extensions

Source§

fn clone(&self) -> Extensions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Extensions

Source§

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

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

impl Default for Extensions

Source§

fn default() -> Extensions

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

Auto Trait Implementations§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Source§

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 T
where U: Into<T>,

Source§

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

Source§

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.