pub struct ToolProgressEvent { /* private fields */ }Expand description
Ordered, identity-bound progress event accepted by the runtime sink.
Implementations§
Source§impl ToolProgressEvent
impl ToolProgressEvent
Sourcepub const fn new(
provenance: ToolProgressProvenance,
sequence: ExecutionCount,
update: ToolProgressUpdate,
) -> Self
pub const fn new( provenance: ToolProgressProvenance, sequence: ExecutionCount, update: ToolProgressUpdate, ) -> Self
Constructs an event from reporter-assigned identity and sequence.
Sourcepub const fn provenance(&self) -> &ToolProgressProvenance
pub const fn provenance(&self) -> &ToolProgressProvenance
Returns exact invocation provenance.
Sourcepub const fn sequence(&self) -> ExecutionCount
pub const fn sequence(&self) -> ExecutionCount
Returns the contiguous zero-based event sequence.
Sourcepub const fn update(&self) -> ToolProgressUpdate
pub const fn update(&self) -> ToolProgressUpdate
Returns the normalized numeric update.
Sourcepub fn validate_for(
&self,
context: &ToolContext,
descriptor: &ToolDescriptor,
) -> Result<(), ToolProgressEventValidationError>
pub fn validate_for( &self, context: &ToolContext, descriptor: &ToolDescriptor, ) -> Result<(), ToolProgressEventValidationError>
Revalidates identity and the descriptor event ceiling.
Contiguous ordering and monotonic progress across multiple events remain the reporter or durable replay accumulator’s responsibility.
§Errors
Returns ToolProgressEventValidationError for substituted context,
invocation, attempt, tool, or an impossible sequence.
Trait Implementations§
Source§impl Clone for ToolProgressEvent
impl Clone for ToolProgressEvent
Source§impl Debug for ToolProgressEvent
impl Debug for ToolProgressEvent
Source§impl<'de> Deserialize<'de> for ToolProgressEvent
impl<'de> Deserialize<'de> for ToolProgressEvent
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Eq for ToolProgressEvent
Source§impl JsonSchema for ToolProgressEvent
impl JsonSchema for ToolProgressEvent
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
Whether JSON Schemas generated for this type should be included directly in parent schemas,
rather than being re-used where possible using the
$ref keyword. Read moreSource§impl PartialEq for ToolProgressEvent
impl PartialEq for ToolProgressEvent
Source§impl Serialize for ToolProgressEvent
impl Serialize for ToolProgressEvent
impl StructuralPartialEq for ToolProgressEvent
Auto Trait Implementations§
impl Forget for ToolProgressEvent
impl Freeze for ToolProgressEvent
impl Move for ToolProgressEvent
impl RefUnwindSafe for ToolProgressEvent
impl Send for ToolProgressEvent
impl Sync for ToolProgressEvent
impl Unpin for ToolProgressEvent
impl UnsafeUnpin for ToolProgressEvent
impl UnwindSafe for ToolProgressEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more