Struct HttpRequestContext 

pub struct HttpRequestContext { /* private fields */ }

Context for HTTP client requests that supports cancellation This bridges AsyncEngineContext and reqwest cancellation

Implementations

impl HttpRequestContext

pub fn new() -> Self

Create a new HTTP request context

pub fn with_id(id: String) -> Self

Create a new context with a specific ID

pub fn child(&self) -> Self

Create a child context from this parent context The child will be cancelled when the parent is cancelled

pub fn child_with_id(&self, id: String) -> Self

Create a child context with a specific ID

pub fn cancellation_token(&self) -> CancellationToken

Get the cancellation token for use with reqwest

pub fn elapsed(&self) -> Duration

Get the elapsed time since context creation

Trait Implementations

impl AsyncEngineContext for HttpRequestContext

fn id(&self) -> &str

Unique ID for the Stream

fn stop(&self)

See AsyncEngineContext::stop_generating.

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

fn link_child(&self, child: Arc<dyn AsyncEngineContext>)

Links child AsyncEngineContext to this AsyncEngineContext. If the stop_generating, stop or kill on this AsyncEngineContext is called, the same method is called on all linked child AsyncEngineContext, in the order they are linked, and then the method on this AsyncEngineContext continues.

impl Clone for HttpRequestContext

fn clone(&self) -> HttpRequestContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequestContext

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

Formats the value using the given formatter.

impl Default for HttpRequestContext

fn default() -> Self

Returns the “default value” for a type.