Skip to main content

Event

Enum Event 

Source
#[non_exhaustive]
pub enum Event {
Show 22 variants RunStarted {
Show 15 fields schema: u32, basis: String, session_id: String, workspace: PathBuf, model: String, provider: String, context_files: Vec<ContextFile>, skills_dirs: Vec<PathBuf>, skills: Vec<SkillSummary>, templates_dirs: Vec<PathBuf>, templates: Vec<TemplateSummary>, mcp_files: Vec<ContextFile>, mcp_servers: Vec<String>, a2a_files: Vec<ContextFile>, a2a_agents: Vec<String>,
}, UserMessage { text: String, image_count: usize, }, AssistantDelta { text: String, }, AssistantReasoningDelta { text: String, }, AssistantMessage { text: String, }, ToolQueued { tool_call_id: String, tool_name: String, summary: String, mutability: Mutability, input: Value, }, ToolStarted { tool_call_id: String, tool_name: String, }, ToolProgress { tool_call_id: String, tool_name: String, progress: String, }, ToolCompleted { tool_call_id: String, tool_name: String, summary: String, is_error: bool, }, PermissionRequested { request_id: String, tool_call_id: String, tool_name: String, description: String, preview: Value, }, PermissionResolved { request_id: String, tool_call_id: String, tool_name: String, outcome: PermissionOutcome, rule_scope: Option<RuleScope>, }, TaskUpdated { task_id: String, kind: TaskKind, status: TaskStatus, title: String, detail: Option<String>, }, CompactionStarted { agent_id: String, }, CompactionCompleted { agent_id: String, replaced_items: usize, preserved_items: usize, transcript_len: usize, extracted_facts: usize, summary_preview: String, }, RequestToolResultsElided { agent_id: String, policy: RequestToolResultElisionPolicy, canonical_tool_result_content_bytes: usize, projected_tool_result_content_bytes: usize, results: Vec<ElidedToolResult>, }, MemoryUpdated { agent_id: String, stored_records: usize, }, Usage { agent_id: String, input_tokens: u64, output_tokens: u64, cache_read_tokens: u64, cache_creation_tokens: u64, reasoning_tokens: u64, thoughts_tokens: u64, }, Notice { severity: NoticeSeverity, message: String, }, Retry { agent_id: String, error: String, attempt: u32, max_attempts: u32, next_delay_ms: u64, }, Error { message: String, recoverable: bool, }, Branched { entry_id: String, abandoned_entries: usize, }, RunFinished { outcome: RunOutcome, stopped_by: Option<Bound>, usage: Option<RunUsage>, },
}
Expand description

Everything that can appear on the stream.

RunStarted and RunFinished are basis’s own bookends; the rest are normalized from mentra’s SessionEvent.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

RunStarted

Always the first line. Carries the schema version.

Fields

§schema: u32
§basis: String
§session_id: String
§workspace: PathBuf
§model: String
§provider: String
§context_files: Vec<ContextFile>

Context files discovered for this run, weakest precedence first.

§skills_dirs: Vec<PathBuf>

Skills directories in effect, most specific first. Omitted rather than empty so a stream without skills stays quiet about them.

§skills: Vec<SkillSummary>

The skills those directories produced, after layering — what the model can actually load by name.

§templates_dirs: Vec<PathBuf>

Template directories in effect, most specific first.

§templates: Vec<TemplateSummary>

The templates those directories produced, after layering — what a client can offer as commands.

§mcp_files: Vec<ContextFile>

MCP configuration files in effect, weakest precedence first.

Named for the same reason context files are, and more urgently: an .mcp.json says which programs to spawn and carries the credentials to spawn them with, so it is the last thing that should take effect without appearing anywhere.

§mcp_servers: Vec<String>

The servers those files produced, after layering. Names only — commands, arguments, and environment stay out of the stream, which is the same no-echo rule McpError follows.

§a2a_files: Vec<ContextFile>

A2A configuration files in effect (.basis/a2a.json, the global a2a.json), named for mcp_files’ reason: such a file says which remote agents may be handed this repository’s work, and with which credential. As of the turn this header opens: the set is live (ADR-0031), so a later turn of the same session may name others.

Additive and omitted when empty, so a schema-2 reader written before the field existed reads a stream that has it, and a stream written before it existed reads as naming none — no version bump.

§a2a_agents: Vec<String>

The remote agents configured for this run’s workspace when this turn began, each one a spawn "@<agent> …" target (ADR-0029, ADR-0031). Names only — a URL or a header is configuration, and this line travels into logs.

§

UserMessage

Fields

§text: String
§image_count: usize

How many images the turn carried. A turn can be images alone, and text is then empty — a consumer rendering only text would show a blank user message. Absent from the line when zero, so a stream written before the field existed reads the same as one after.

§

AssistantDelta

Fields

§text: String
§

AssistantReasoningDelta

Fields

§text: String
§

AssistantMessage

Fields

§text: String
§

ToolQueued

Fields

§tool_call_id: String
§tool_name: String
§summary: String
§mutability: Mutability
§input: Value

Parsed tool input when it is valid JSON, else the raw string.

§

ToolStarted

Fields

§tool_call_id: String
§tool_name: String
§

ToolProgress

Fields

§tool_call_id: String
§tool_name: String
§progress: String
§

ToolCompleted

Fields

§tool_call_id: String
§tool_name: String
§summary: String
§is_error: bool
§

PermissionRequested

Fields

§request_id: String
§tool_call_id: String
§tool_name: String
§description: String
§preview: Value

Parsed preview when it is valid JSON, else the raw string.

§

PermissionResolved

Fields

§request_id: String
§tool_call_id: String
§tool_name: String
§rule_scope: Option<RuleScope>
§

TaskUpdated

Fields

§task_id: String
§status: TaskStatus
§title: String
§detail: Option<String>
§

CompactionStarted

Fields

§agent_id: String
§

CompactionCompleted

Fields

§agent_id: String
§replaced_items: usize
§preserved_items: usize
§transcript_len: usize
§extracted_facts: usize
§summary_preview: String
§

RequestToolResultsElided

Tool-result bodies were reduced only in one provider-request projection.

This is distinct from canonical compaction: the stored transcript stays unchanged, and the event carries byte counts and actions but no body snippets.

Fields

§agent_id: String
§canonical_tool_result_content_bytes: usize

Sum across every canonical tool-result body in the request.

§projected_tool_result_content_bytes: usize

Sum across every projected tool-result body, including markers.

§results: Vec<ElidedToolResult>

Changed results in request order.

§

MemoryUpdated

Fields

§agent_id: String
§stored_records: usize
§

Usage

Fields

§agent_id: String
§input_tokens: u64
§output_tokens: u64
§cache_read_tokens: u64
§cache_creation_tokens: u64
§reasoning_tokens: u64

Reasoning counted inside output_tokens (the Responses wire).

§thoughts_tokens: u64

Thinking counted outside output_tokens (Gemini). Kept apart from reasoning_tokens for the reason RunUsage gives: a sum would be wrong for one of the two wires.

§

Notice

Fields

§severity: NoticeSeverity

Defaulted on read — leniency for the reader only, the writer always states it: journals written before 0.6.0 hold the CLI’s synthetic notices with no severity at all, and the message is the part a person needs.

§message: String
§

Retry

Fields

§agent_id: String
§error: String
§attempt: u32
§max_attempts: u32
§next_delay_ms: u64
§

Error

Fields

§message: String
§recoverable: bool
§

Branched

The session returned to an earlier entry; later turns continue from there along a different path.

Fields

§entry_id: String
§abandoned_entries: usize

How many entries left the active path. They stay in the transcript and remain reachable.

§

RunFinished

Always the last line.

Fields

§outcome: RunOutcome
§stopped_by: Option<Bound>

The bound that ended the run, when one did — the same fact the CLI’s exit 3 carries, for a consumer reading the stream instead of the exit code. Absent, not null, on an unbounded finish, so a schema-1 consumer that never heard of it reads the line unchanged.

§usage: Option<RunUsage>

What the run reported spending, summed over its rounds — the same figure RunReport::usage carries in-process, for the consumers that only ever see the stream.

It rides the finish line because a total is only a total once the run is over; the per-round Event::Usage reports are still there for anyone metering as it goes. basis ships no price table — that is the host’s, and prices change — so this is the last basis-side fact between a run and a bill.

Absent, not zero, when the producer stated nothing: an old stream and a run that cost nothing are different claims, and only one of them is worth acting on. Optional and additive, so EVENT_SCHEMA_VERSION does not move for it.

Implementations§

Source§

impl Event

Source

pub fn from_session_event(event: &SessionEvent) -> Option<Self>

Normalizes a mentra session event, or None when basis’s stream already carries the information some other way.

Source

pub fn type_tag(&self) -> &'static str

The wire tag #[serde(tag = "type")] writes for this variant, without serializing anything to ask.

Same-crate, exhaustive, no wildcard — deliberately, and always compiled: a variant landing on this enum fails this match first, which is the tripwire that forces the sibling crates’ wildcard arms (basis-acp/src/update.rs, the CLI renderer’s progress_line) to be revisited before the new variant can be silently eaten.

Trait Implementations§

Source§

impl Clone for Event

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 Event

Source§

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

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

impl<'de> Deserialize<'de> for Event

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 Event

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 Event

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 Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more