Skip to main content

JobHandle

Struct JobHandle 

Source
pub struct JobHandle {
    pub job_id: JobId,
    pub correlation_id: MessageId,
    /* private fields */
}
Expand description

Handle to an in-flight job (RFC §10).

Fields§

§job_id: JobId

Server-assigned job identifier.

§correlation_id: MessageId

Correlation id of the originating tool.invoke.

Implementations§

Source§

impl JobHandle

Source

pub async fn join(&self) -> Result<Value, ARCPError>

Await the terminal job event.

§Errors

Returns ARCPError::Cancelled if the job ended via job.cancelled, ARCPError::Unknown for job.failed, or ARCPError::Unavailable if the connection ended before the terminal event was observed.

Source

pub async fn cancel(&self, reason: impl Into<String>) -> Result<(), ARCPError>

Send a cancel envelope for this job. Does not await the cancel.accepted reply; the next Self::join reflects the cancellation outcome.

§Errors

Returns ARCPError::Unavailable if the transport is already closed.

Trait Implementations§

Source§

impl Debug for JobHandle

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V