Skip to main content

NodeContext

Struct NodeContext 

Source
pub struct NodeContext {
    pub node_id: Arc<str>,
    pub exec_id: Arc<str>,
    pub frame: FrameId,
    pub attempt: u32,
    pub pool: VariablePool,
    pub services: Arc<Services>,
    pub clock: Arc<dyn Clock>,
    pub resume: Option<Resume>,
    pub subgraph: Option<Arc<dyn Subgraph>>,
    pub deadline_ms: Option<u64>,
    /* private fields */
}
Expand description

Everything a node may use while running. Cheap to clone.

Fields§

§node_id: Arc<str>§exec_id: Arc<str>§frame: FrameId§attempt: u32

1-based attempt number (increments on retries).

§pool: VariablePool

Snapshot of the frame’s variables at the time the node started.

§services: Arc<Services>§clock: Arc<dyn Clock>§resume: Option<Resume>

Present when the node is resumed after pausing.

§subgraph: Option<Arc<dyn Subgraph>>

Present for container nodes.

§deadline_ms: Option<u64>

Absolute deadline of the current attempt in Clock::now_ms time, when the node has an effective timeout. See NodeContext::remaining.

Implementations§

Source§

impl NodeContext

Source

pub fn new( node_id: impl Into<Arc<str>>, exec_id: impl Into<Arc<str>>, frame: FrameId, attempt: u32, pool: VariablePool, services: Arc<Services>, clock: Arc<dyn Clock>, sink: EventSink, ) -> Self

Construct a context. Used by the engine and by node unit tests.

Source

pub fn for_test(node_id: &str, pool: VariablePool) -> Self

A context with an empty pool and a no-op sink, for unit tests.

Source

pub fn with_services(self, services: Arc<Services>) -> Self

Source

pub fn with_sink(self, sink: EventSink) -> Self

Source

pub fn with_resume(self, resume: Option<Resume>) -> Self

Source

pub fn with_subgraph(self, subgraph: Option<Arc<dyn Subgraph>>) -> Self

Source

pub fn with_deadline(self, deadline_ms: Option<u64>) -> Self

Source

pub fn remaining(&self) -> Option<Duration>

Time left before the current attempt times out, if it has a deadline. Nodes that block synchronously (e.g. an embedded interpreter) should cap their own work by this.

Source

pub fn service<T: Any + Send + Sync>(&self) -> Option<&T>

Look up a host service.

Source

pub fn require_service<T: Any + Send + Sync>( &self, what: &str, ) -> Result<&T, NodeError>

Look up a host service or fail with a descriptive error.

Source

pub fn get(&self, selector: &Selector) -> Option<Value>

Resolve a selector against the pool snapshot.

Source

pub fn chunk(&self, field: &str, chunk: impl Into<String>)

Stream an incremental chunk for output field.

Source

pub fn progress(&self, name: &str, data: Value)

Report structured progress.

Source

pub fn sink(&self) -> &EventSink

Raw access to the event sink (used by container implementations).

Trait Implementations§

Source§

impl Clone for NodeContext

Source§

fn clone(&self) -> Self

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 NodeContext

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, 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 = !

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.