Struct StepResult 

#[repr(C)]
pub struct StepResult {
    pub tag: StepResultTag,
    pub payload: StepResultPayload,
}

Return value of ToolPollFn. The blocking driver matches on tag, reads the matching payload, and breaks the loop on Done/Err.

Fields

tag: StepResultTag

payload: StepResultPayload

Implementations

impl StepResult

pub fn pending(progress: StbString) -> Self

Build a Pending with a progress JSON string (may be empty).

pub fn done(result: StbString) -> Self

Build a Done with the terminal JSON AgentToolResult.

pub fn err(message: StbString) -> Self

Build an Err with an error message.

pub unsafe fn pending_payload(&self) -> &StbPending

Access the pending payload. Caller MUST guarantee tag == Pending.

Safety

Undefined behavior if tag != StepResultTag::Pending.

pub unsafe fn done_payload(&self) -> &StbDone

Access the done payload. Caller MUST guarantee tag == Done.

Safety

Undefined behavior if tag != StepResultTag::Done.

pub unsafe fn err_payload(&self) -> &StbErr

Access the err payload. Caller MUST guarantee tag == Err.

Safety

Undefined behavior if tag != StepResultTag::Err.

Trait Implementations

impl Clone for StepResult

fn clone(&self) -> StepResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StepResult