Struct StreamContext

pub struct StreamContext { /* private fields */ }

Implementations

impl StreamContext

pub fn get<V: Send + Sync + 'static>(&self, key: &str) -> Result<Arc<V>, String>

Retrieve an object from the registry by key and type.

pub fn clone_unique<V: Clone + Send + Sync + 'static>( &self, key: &str, ) -> Result<V, String>

Clone a unique object from the registry by key and type.

pub fn registry(&self) -> Arc<Registry>

pub fn stages(&self) -> &Vec<String>

pub fn add_stage(&mut self, stage: &str)

Trait Implementations

impl AsyncEngineContext for StreamContext

fn id(&self) -> &str

Unique ID for the Stream

fn stop(&self)

See AsyncEngineContext::stop_generating.

fn kill(&self)

Extends the AsyncEngineContext::stop_generating also indicates a preference to terminate without draining the remaining items in the stream. This is implementation specific and may not be supported by all engines.

fn stop_generating(&self)

Informs the AsyncEngine to stop producing results for this particular stream. This method is idempotent. This method does not invalidate results current in the stream. It might take some time for the engine to stop producing results. The caller can decided to drain the stream or drop the stream.

fn is_stopped(&self) -> bool

Returns true if stop_generating() has been called; otherwise, false.

fn is_killed(&self) -> bool

Returns true if kill() has been called; otherwise, false. This can be used with a .take_while() stream combinator to immediately terminate the stream.

fn stopped<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Calling this method when AsyncEngineContext::is_stopped is true will return immediately; otherwise, it will AsyncEngineContext::is_stopped will return true.

fn killed<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Calling this method when AsyncEngineContext::is_killed is true will return immediately; otherwise, it will AsyncEngineContext::is_killed will return true.

impl AsyncEngineContextProvider for StreamContext

fn context(&self) -> Arc<dyn AsyncEngineContext>

impl Clone for StreamContext

fn clone(&self) -> StreamContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamContext

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

Formats the value using the given formatter.

impl<T: Send + Sync + 'static> From<Context<T>> for StreamContext

fn from(value: Context<T>) -> Self

Converts to this type from the input type.