Struct CompactionUpdate 

#[non_exhaustive]
pub struct CompactionUpdate {
    pub compaction_id: CompactionId,
    pub status: CompactionStatus,
    pub summary: MaybeUndefined<Vec<ContentBlock>>,
    pub error: MaybeUndefined<String>,
    pub meta: MaybeUndefined<Meta>,
}

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A context compaction upsert. The first update fixes the compaction’s timeline position. Later updates with the same ID patch that entity in place. Agents MUST only send this update when the Client advertised ClientSessionCapabilities::compaction.

summary, error, and _meta have patch semantics: omission leaves the stored value unchanged, null clears it, and a concrete value replaces it. summary: [] also clears the retained summary. A non-empty summary is only valid with completed; error is only valid with failed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

compaction_id: CompactionId

The Agent-owned ID of this compaction, unique within the session.

status: CompactionStatus

Current lifecycle status.

summary: MaybeUndefined<Vec<ContentBlock>>

Complete replacement user-displayable summary retained by the compaction.

error: MaybeUndefined<String>

Human-readable description of why the compaction failed.

meta: MaybeUndefined<Meta>

Extensible metadata patch for this compaction.

Implementations

impl CompactionUpdate

pub fn new( compaction_id: impl Into<CompactionId>, status: CompactionStatus, ) -> Self

Available on crate feature unstable_session_compaction only.

Builds a compaction update with optional patch fields omitted.

pub fn summary( self, summary: impl IntoMaybeUndefined<Vec<ContentBlock>>, ) -> Self

Available on crate feature unstable_session_compaction only.

Sets, clears, or omits the complete retained summary patch.

pub fn error(self, error: impl IntoMaybeUndefined<String>) -> Self

Available on crate feature unstable_session_compaction only.

Sets, clears, or omits the failure description patch.

pub fn meta(self, meta: impl IntoMaybeUndefined<Meta>) -> Self

Available on crate feature unstable_session_compaction only.

Sets, clears, or omits the metadata patch.

Trait Implementations

impl Clone for CompactionUpdate

fn clone(&self) -> CompactionUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompactionUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompactionUpdate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CompactionUpdate

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

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.

impl PartialEq for CompactionUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CompactionUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CompactionUpdate