Skip to main content

SortedRegistry

Struct SortedRegistry 

Source
pub struct SortedRegistry<T> { /* private fields */ }
Expand description

A named registry that maintains a sorted order by priority.

Items are stored by unique string name and sorted by an integer priority extracted via a caller-provided function. The sort is performed eagerly: every register or deregister call re-sorts immediately, so sorted_values is a read-only lookup.

§Priority ordering

Entries are sorted in ascending priority order (lower numbers run first). This means a guardrail with priority 1 executes before one with priority 10.

§Uniqueness

Names must be unique within a registry. Attempting to register a duplicate name returns an error. Use deregister first to remove an existing entry before re-registering.

Implementations§

Source§

impl<T> SortedRegistry<T>

Source

pub fn new(priority_fn: fn(&T) -> i32) -> Self

Create a new empty registry with the given priority extraction function.

The runtime calls priority_fn on each stored entry to determine its sort key. Lower values are ordered first.

§Parameters
  • priority_fn: Function used to extract the integer priority from a stored entry.
§Returns

A new empty SortedRegistry with no entries.

Source

pub fn register(&mut self, name: String, entry: T) -> Result<(), String>

Register a new entry under a unique name.

§Parameters
  • name: Unique name used to address the entry later.
  • entry: Value to store in the registry.
§Returns

Ok(()) when the entry was inserted.

§Errors

Returns Err(String) when name is already present in the registry.

§Notes

Successful registration eagerly re-sorts the cached priority order.

Source

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

Deregister an entry by name.

§Parameters
  • name: Name of the entry to remove.
§Returns

true when an entry was removed and false when name was not present.

§Notes

Successful removal eagerly re-sorts the cached priority order.

Source

pub fn sorted_values(&self) -> Vec<&T>

Return entries sorted by priority (ascending).

This is a read-only operation — the sort order is maintained eagerly on every register / deregister call.

§Returns

A newly allocated Vec of shared references ordered from lowest priority to highest priority.

Source

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

Return a shared reference to an entry by name.

§Parameters
  • name: Name of the entry to resolve.
§Returns

Some(&T) when an entry exists under name, otherwise None.

Source

pub fn remove(&mut self, name: &str) -> Option<T>

Remove and return an entry by name.

§Parameters
  • name: Name of the entry to remove.
§Returns

Some(T) when an entry was removed, otherwise None.

§Notes

Successful removal eagerly re-sorts the cached priority order.

Source

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

Report whether an entry with the given name exists.

§Parameters
  • name: Name to test for membership.
§Returns

true when the registry contains name, otherwise false.

Auto Trait Implementations§

§

impl<T> Freeze for SortedRegistry<T>

§

impl<T> RefUnwindSafe for SortedRegistry<T>
where T: RefUnwindSafe,

§

impl<T> Send for SortedRegistry<T>
where T: Send,

§

impl<T> Sync for SortedRegistry<T>
where T: Sync,

§

impl<T> Unpin for SortedRegistry<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SortedRegistry<T>

§

impl<T> UnwindSafe for SortedRegistry<T>
where T: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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<V, T> VZip<V> for T
where 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