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: u321-based attempt number (increments on retries).
pool: VariablePoolSnapshot 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
impl NodeContext
Sourcepub 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
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.
Sourcepub fn for_test(node_id: &str, pool: VariablePool) -> Self
pub fn for_test(node_id: &str, pool: VariablePool) -> Self
A context with an empty pool and a no-op sink, for unit tests.
pub fn with_services(self, services: Arc<Services>) -> Self
pub fn with_sink(self, sink: EventSink) -> Self
pub fn with_resume(self, resume: Option<Resume>) -> Self
pub fn with_subgraph(self, subgraph: Option<Arc<dyn Subgraph>>) -> Self
pub fn with_deadline(self, deadline_ms: Option<u64>) -> Self
Sourcepub fn remaining(&self) -> Option<Duration>
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.
Sourcepub fn require_service<T: Any + Send + Sync>(
&self,
what: &str,
) -> Result<&T, NodeError>
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.
Sourcepub fn get(&self, selector: &Selector) -> Option<Value>
pub fn get(&self, selector: &Selector) -> Option<Value>
Resolve a selector against the pool snapshot.
Sourcepub fn chunk(&self, field: &str, chunk: impl Into<String>)
pub fn chunk(&self, field: &str, chunk: impl Into<String>)
Stream an incremental chunk for output field.
Allocates the field name for every chunk; nodes that stream many chunks
should keep the name in an Arc<str> and use NodeContext::chunk_shared.
Stream an incremental chunk for output field, sharing the field name
(no allocation besides the chunk text itself).
let field: Arc<str> = Arc::from("text");
for token in ["Hel", "lo"] {
ctx.chunk_shared(&field, token);
}