Skip to main content

ScopeStack

Struct ScopeStack 

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

Mutable stack of active scopes plus their scope-local registries.

The stack always contains an implicit root scope. Additional scopes are pushed as the public API opens lifecycle spans and removed when those spans close.

Implementations§

Source§

impl ScopeStack

Source

pub fn new() -> Self

Create a new scope stack containing only the implicit root scope.

§Returns

A ScopeStack initialized with a single root scope and no scope-local registries.

Source

pub fn push(&mut self, handle: ScopeHandle)

Push a scope handle onto the top of the stack.

§Parameters
  • handle: Scope handle to make the new top-most active scope.
Source

pub fn top(&self) -> &ScopeHandle

Return the current top-most scope handle.

§Returns

A shared reference to the active scope at the top of the stack.

§Notes

This function never returns None because the implicit root scope is always present.

Source

pub fn top_mut(&mut self) -> &mut ScopeHandle

Return the current top-most scope handle mutably.

§Returns

A mutable reference to the active scope at the top of the stack.

Source

pub fn root_uuid(&self) -> Uuid

Return the UUID of the implicit root scope.

§Returns

The stable UUID of the root scope stored at the bottom of the stack.

Source

pub fn scopes(&self) -> &[ScopeHandle]

Return the full ordered stack of scope handles.

§Returns

A slice of scopes ordered from root to the current top-most scope.

Source

pub fn find(&self, uuid: &Uuid) -> Option<&ScopeHandle>

Find a scope handle by UUID.

§Parameters
  • uuid: UUID of the scope to search for.
§Returns

Some(&ScopeHandle) when the scope is active on this stack and None otherwise.

Source

pub fn remove(&mut self, uuid: &Uuid) -> Result<ScopeHandle>

Remove the current top scope if it matches uuid.

§Parameters
  • uuid: UUID of the scope expected to be at the top of the stack.
§Returns

A Result containing the removed ScopeHandle.

§Errors

Returns FlowError::InvalidArgument when the scope exists but is not the current top of the stack or when the caller attempts to remove the implicit root scope. Returns FlowError::NotFound when the UUID is not present on the stack.

Source

pub fn local_registries_mut( &mut self, uuid: &Uuid, ) -> Option<&mut ScopeLocalRegistries>

Get or create the scope-local registries for an active scope.

§Parameters
  • uuid: UUID of an active scope on this stack.
§Returns

Some(&mut ScopeLocalRegistries) when the scope is active and None otherwise.

§Notes

When the scope is active but has no registries yet, this function creates an empty scope-local registry set first.

Source

pub fn collect_scope_local_registries<'a, T>( &'a self, field: impl Fn(&'a ScopeLocalRegistries) -> &'a SortedRegistry<T>, ) -> Vec<&'a SortedRegistry<T>>

Collect one registry field from every active scope that owns it.

§Parameters
  • field: Projection function selecting the registry field to collect from each scope-local registry.
§Returns

A vector of registry references ordered from root toward the current top-most scope.

Source

pub fn collect_scope_local_subscribers(&self) -> Vec<EventSubscriberFn>

Collect all scope-local subscribers visible from the active stack.

§Returns

A vector of subscribers collected from each active scope that owns scope-local registries.

Source

pub fn scope_registries_get(&self, uuid: &Uuid) -> Option<&ScopeLocalRegistries>

Return the scope-local registries for uuid without creating them.

§Parameters
  • uuid: UUID of the scope whose registries should be borrowed.
§Returns

Some(&ScopeLocalRegistries) when registries already exist for that scope and None otherwise.

Trait Implementations§

Source§

impl Debug for ScopeStack

Source§

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

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

impl Default for ScopeStack

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