Struct RunningStateUpdate 

#[non_exhaustive]
pub struct RunningStateUpdate {
    pub background: Option<Vec<BackgroundWork>>,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

Foreground work is in progress.

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.

background: Option<Vec<BackgroundWork>>

Work running independently of foreground work, as a complete snapshot.

Optional. Omitted and null are equivalent and mean the Agent is not reporting background work, not that nothing is running. [] means no background work is running. An Agent that reports background work MUST include it on every state update for the session. A malformed list is treated as not reported.

See protocol docs: Background Work

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations

impl RunningStateUpdate

pub fn new() -> Self

Builds RunningStateUpdate with the required fields set. Optional fields start unset or empty.

pub fn background( self, background: impl IntoOption<Vec<BackgroundWork>>, ) -> Self

Work running independently of foreground work, as a complete snapshot.

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

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations

impl Clone for RunningStateUpdate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunningStateUpdate

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

Formats the value using the given formatter.

impl Default for RunningStateUpdate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunningStateUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RunningStateUpdate

impl JsonSchema for RunningStateUpdate

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 RunningStateUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RunningStateUpdate

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 RunningStateUpdate