Skip to main content

CapabilityRegistry

Struct CapabilityRegistry 

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

Per-node registry that owns capability instances, generates the local advertisement, and stores the most recently negotiated value for each capability.

Implementations§

Source§

impl CapabilityRegistry

Source

pub fn new() -> Self

Construct an empty registry.

Source

pub fn register<C: Capability>(&mut self, cap: C)

Register a capability. Re-registering a capability with the same name replaces the previous entry; the cluster layer never registers two caps with the same name, so this only matters for tests.

Source

pub fn local_advertise(&self) -> CapabilityAd

Build the advertisement to ship to peers.

Source

pub fn negotiate(&self, peer_ad: &CapabilityAd) -> NegotiatedCapabilities

Resolve peer_ad against the locally registered caps.

Returns a NegotiatedCapabilities keyed by capability name. The registry also caches each negotiated value so later calls to CapabilityRegistry::current reflect the most recent negotiation.

Capabilities present in peer_ad but not registered locally fall through silently: the negotiator can only pick a value for capabilities both sides know about.

Source

pub fn current<C: Capability>(&self, name: &str) -> Option<C::Value>

Return the currently active value for the named capability, decoded with the registered cap’s Capability::decode_value.

Returns None when no capability with that name is registered, when the type parameter C does not match the registered cap, or when the stored bytes fail to decode (which would be a registry bug).

Before any negotiation has happened the floor value (lowest-preference local value) is returned.

Source

pub fn len(&self) -> usize

Number of registered capabilities. Useful in tests and diagnostics.

Source

pub fn is_empty(&self) -> bool

True when no capabilities have been registered.

Trait Implementations§

Source§

impl Debug for CapabilityRegistry

Source§

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

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

impl Default for CapabilityRegistry

Source§

fn default() -> Self

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

Source§

type Output = T

Should always be Self
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
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,