Skip to main content

ControllerSnapshot

Struct ControllerSnapshot 

Source
#[non_exhaustive]
pub struct ControllerSnapshot { pub slots: Vec<SlotView>, }
Available on crate feature controller only.
Expand description

A rolling read-only view of the slots tracked by one controller.

Each SlotView reports one slot’s owner, status, pending depth, and time in that status. Entries appear in slot-key order.

§Consistency

The controller does not read every slot at one exact moment. A slot created during collection may be absent. A removed slot may still appear. Any state can change after this value is returned. Commands still waiting in the controller command queue do not appear until the controller processes them.

This struct is non-exhaustive. Use .. when matching it.

§Examples

if let Some(snapshot) = handle.controller_snapshot().await {
    println!(
        "{} running, {} queued",
        snapshot.running_count(),
        snapshot.total_queued(),
    );

    if let Some(deploy) = snapshot.slot("deploy") {
        println!("deploy: {:?}, queued: {}", deploy.status, deploy.queue_depth);
    }
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§slots: Vec<SlotView>

Captured slots in slot-key order.

Implementations§

Source§

impl ControllerSnapshot

Source

pub fn running_count(&self) -> usize

Counts captured slots in the exact SlotStatusKind::Running state.

This excludes Admitting and Terminating, including runtime-accepted owners already being retired. It is not a count of task bodies polling at this exact moment.

Source

pub fn total_queued(&self) -> usize

Counts pending submissions across all captured slot queues.

This includes replacements waiting at the front of a queue and excludes current owners.

Source

pub fn slot(&self, name: &str) -> Option<&SlotView>

Finds a captured slot by its exact effective admission key.

Source

pub fn len(&self) -> usize

Returns the number of captured slots.

Source

pub fn is_empty(&self) -> bool

Returns true when no slots were captured.

Trait Implementations§

Source§

impl Clone for ControllerSnapshot

Source§

fn clone(&self) -> ControllerSnapshot

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 ControllerSnapshot

Source§

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

Formats the value using the given formatter. 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> 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> 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