Struct Notice 

#[non_exhaustive]
pub struct Notice {
    pub severity: NoticeSeverity,
    pub title: String,
    pub description: Option<String>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Fire-and-forget information for the user.

Notices are live events rather than session history. Agents must not rely on a notice being received, displayed, or seen by the user. No Client capability is required, and unsupported Clients may ignore notices.

See protocol docs: Session Notices

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.

severity: NoticeSeverity

Presentation severity hint.

title: String

Required non-empty plain-text title that can stand alone.

description: Option<String>

Optional plain-text detail or guidance.

Omitted and null are equivalent and mean no description was supplied.

meta: Option<Map<String, Value>>

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 make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl Notice

pub fn new(severity: NoticeSeverity, title: impl Into<String>) -> Notice

Builds a notice with the required fields set and optional fields omitted.

pub fn description(self, description: impl IntoOption<String>) -> Notice

Sets or clears the optional description.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> Notice

Sets or clears notice-scoped metadata.

Trait Implementations

impl Clone for Notice

fn clone(&self) -> Notice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Notice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Notice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Notice

impl JsonSchema for Notice

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 Notice

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Notice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Notice