Skip to main content

Step

Struct Step 

Source
pub struct Step {
Show 14 fields pub id: u64, pub tool: String, pub title: String, pub access: ToolAccess, pub status: StepStatus, pub detail: String, pub changes: Vec<FileChange>, pub at: usize, pub media: Vec<MediaRef>, pub preview: Option<Preview>, pub artifacts: Vec<ArtifactRef>, pub delegation: Option<Box<Delegation>>, pub ask: Option<Box<Ask>>, pub views: Vec<View>,
}
Expand description

One tool call inside an assistant reply.

Fields§

§id: u64

Unique within the engine; also the approval id.

§tool: String

Tool name, e.g. read_file.

§title: String

Short human title, e.g. “Read notes.md”.

§access: ToolAccess§status: StepStatus§detail: String

Short detail: the arguments while running or waiting, then a result excerpt or reason.

§changes: Vec<FileChange>§at: usize

Byte offset into the entry’s content when the step started, for interleaving.

§media: Vec<MediaRef>

Charts and images this call made, shown inline.

§preview: Option<Preview>

What the call will do, readable, for the approval card and the expanded row.

§artifacts: Vec<ArtifactRef>

Artifact versions this call made, shown as cards where it happened.

§delegation: Option<Box<Delegation>>

The subagent run of a delegate step: its live transcript.

§ask: Option<Box<Ask>>

Set when the approval card isn’t an ordinary tool call: a question a tool asks while it runs, or a call a person must confirm every time. Such cards offer only Allow and Deny.

§views: Vec<View>

Cards shown under the step (Views, e.g. a byob.plugin_card when it made, changed, kept or removed a plugin). Set on the finished step, and stored with it (a transcript loaded from storage has them too).

Implementations§

Source§

impl Step

Source

pub fn view<T: ViewData>(&self) -> Option<T>

The step’s first view of type T this build can read.

Trait Implementations§

Source§

impl Clone for Step

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 Step

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Step

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Step

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Step

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Step

Auto Trait Implementations§

§

impl Forget for Step

§

impl Freeze for Step

§

impl Move for Step

§

impl RefUnwindSafe for Step

§

impl Send for Step

§

impl Sync for Step

§

impl Unpin for Step

§

impl UnsafeUnpin for Step

§

impl UnwindSafe for Step

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.