Skip to main content

Context

Struct Context 

Source
pub struct Context<M: MetricsState = DfirMetrics> { /* private fields */ }
Expand description

A lightweight context for inline codegen that avoids the overhead of the full scheduled graph (no tokio channels, no scheduler queues, no loop machinery).

Exposes methods that operator-generated code calls on both df (for prologues: request_task) and context (for iterators: current_tick, schedule_subgraph, etc.).

§Metrics typestate

The M type parameter is a MetricsState typestate which statically records whether this context tracks runtime metrics:

  • Context<DfirMetrics> (the default) is created via Context::new_with_metrics and holds a shared Rc<DfirMetrics> handle, accessible via Context::metrics.
  • Context<()> is created via Context::new and holds no metrics state whatsoever. The metrics() accessor does not exist on it, so it is a compile error to try to read metrics from a context which never tracked them.

Implementations§

Source§

impl Context<()>

Source

pub fn new() -> Self

Create a new inline context with a fresh wake state and no metrics tracking.

The returned Context<()> statically contains no metrics state. Use Context::new_with_metrics to create a Context<DfirMetrics> which tracks metrics.

Source§

impl Context<DfirMetrics>

Source

pub fn new_with_metrics(metrics: DfirMetrics) -> Self

Create a new inline context with a fresh wake state and the given (pre-populated) metrics.

Source

pub fn metrics(&self) -> &Rc<DfirMetrics>

Returns a reference to the runtime metrics.

Source§

impl<M: MetricsState> Context<M>

Source

pub fn request_task<Fut>(&mut self, future: Fut)
where Fut: Future<Output = ()> + Send + 'static,

Available on crate feature tokio only.

Buffers an async task to be spawned later by Dfir::spawn_tasks.

Tasks are deferred because write_prologue runs during graph construction, which may occur before a tokio runtime is entered. Buffered tasks are drained and spawned via [tokio::spawn] at the start of Dfir::run_tick. Tasks requested after that point remain buffered until the next call to Dfir::run_tick.

The future must be Send so that the Context remains Send and so the task can be spawned onto any tokio runtime.

Source

pub fn current_tick(&self) -> TickInstant

Gets the current tick count.

Source

pub fn schedule_subgraph(&self, is_external: bool)

Signals that external data has arrived and a new tick should be started.

Source

pub fn waker(&self) -> Waker

Returns a waker that signals external data has arrived.

Trait Implementations§

Source§

impl Default for Context<()>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<M = DfirMetrics> !RefUnwindSafe for Context<M>

§

impl<M = DfirMetrics> !Sync for Context<M>

§

impl<M = DfirMetrics> !UnwindSafe for Context<M>

§

impl<M> Freeze for Context<M>
where <M as MetricsState>::Handle: Freeze,

§

impl<M> Send for Context<M>
where <M as MetricsState>::Handle: Send,

§

impl<M> Unpin for Context<M>
where <M as MetricsState>::Handle: Unpin,

§

impl<M> UnsafeUnpin for Context<M>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> ToSinkBuild for T

§

fn iter_to_sink_build(self) -> SendIterBuild<Self>
where Self: Sized + Iterator,

Starts a [SinkBuild] adaptor chain to send all items from self as an Iterator.
§

fn stream_to_sink_build(self) -> SendStreamBuild<Self>
where Self: Sized + Stream,

Starts a [SinkBuild] adaptor chain to send all items from self as a [Stream].
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more