Skip to main content

ExtensionPoint

Struct ExtensionPoint 

Source
pub struct ExtensionPoint<T: ?Sized> { /* private fields */ }
Expand description

Typed, name-indexed collection of Arc<T>.

Cheap to clone; clones share the same underlying entries.

Implementations§

Source§

impl<T: ?Sized> ExtensionPoint<T>

Source

pub fn new() -> Self

Construct an empty extension point.

Source

pub fn len(&self) -> usize

Number of registered entries.

Source

pub fn is_empty(&self) -> bool

Returns true if the extension point has no entries.

Source

pub fn names(&self) -> Vec<String>

Returns a sorted list of registered names. Sorting makes the result stable for snapshot tests and log output.

Source

pub fn snapshot(&self) -> Vec<(String, Arc<T>)>

Take a consistent snapshot of (name, Arc<T>) pairs.

Source§

impl<T: ?Sized + Send + Sync + 'static> ExtensionPoint<T>

Source

pub fn register( &self, name: impl Into<String>, value: Arc<T>, ) -> Result<(), ExtensionError>

Register a new entry. Errors if the name is already in use.

§Errors
Source

pub fn register_or_replace( &self, name: impl Into<String>, value: Arc<T>, ) -> Option<Arc<T>>

Register a new entry, replacing any existing one with the same name. Returns the previous Arc<T>, or None if there was none.

Source

pub fn unregister(&self, name: &str) -> Result<Option<Arc<T>>, ExtensionError>

Remove an entry. Returns the removed Arc<T>, or None if the name was not present.

Refuses to remove an entry whose strong count is greater than one (i.e. external callers still hold a reference).

Source

pub fn replace(&self, name: &str, new: Arc<T>) -> Result<Arc<T>, ExtensionError>

Atomically replace an entry. Returns the previous Arc<T>, or ExtensionError::NotFound if the name was not present.

After this call, new ExtensionPoint::get calls return new. Callers that already hold the old Arc<T> continue to operate on the old instance until they drop it.

§Errors
Source

pub fn get(&self, name: &str) -> Option<Arc<T>>

Look up an entry by name.

Source

pub fn get_required(&self, name: &str) -> Result<Arc<T>, ExtensionError>

Look up an entry by name, returning ExtensionError::NotFound if missing.

Source

pub fn contains(&self, name: &str) -> bool

Returns true if the given name is registered.

Trait Implementations§

Source§

impl<T: ?Sized> Clone for ExtensionPoint<T>

Source§

fn clone(&self) -> Self

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<T: ?Sized> Default for ExtensionPoint<T>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<T> Freeze for ExtensionPoint<T>
where T: ?Sized,

§

impl<T> RefUnwindSafe for ExtensionPoint<T>
where T: ?Sized,

§

impl<T> Send for ExtensionPoint<T>
where T: Sync + Send + ?Sized,

§

impl<T> Sync for ExtensionPoint<T>
where T: Sync + Send + ?Sized,

§

impl<T> Unpin for ExtensionPoint<T>
where T: ?Sized,

§

impl<T> UnsafeUnpin for ExtensionPoint<T>
where T: ?Sized,

§

impl<T> UnwindSafe for ExtensionPoint<T>
where T: ?Sized,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

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

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 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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