Skip to main content

RunCtx

Struct RunCtx 

Source
pub struct RunCtx { /* private fields */ }
Expand description

Per-request context: streaming, progress, logs and cancellation.

Implementations§

Source§

impl RunCtx

Source

pub fn request_id(&self) -> &str

Source

pub fn chunk(&self, field: &str, chunk: &str)

Stream text for output field.

Source

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

Report structured progress.

Source

pub fn log(&self, level: &str, message: &str)

Log a line on the host (debug, info, warn or error).

Source

pub fn is_cancelled(&self) -> bool

Whether the host cancelled this request.

Source

pub async fn cancelled(&self)

Resolves when the host cancels this request.

Trait Implementations§

Source§

impl Clone for RunCtx

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 RunCtx

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Forget for RunCtx

§

impl Freeze for RunCtx

§

impl Move for RunCtx

§

impl RefUnwindSafe for RunCtx

§

impl Send for RunCtx

§

impl Sync for RunCtx

§

impl Unpin for RunCtx

§

impl UnsafeUnpin for RunCtx

§

impl UnwindSafe for RunCtx

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.