Struct Notice 

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

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. Agents MUST only send notices when the Client advertised the session.notices Client capability. Otherwise, Agents may use an agent message when the information should still be surfaced to the user.

See RFD: 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<Meta>

Metadata scoped to this notice.

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

Implementations

impl Notice

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

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

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

Sets or clears the optional description.

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

Sets or clears notice-scoped metadata.

Trait Implementations

impl Clone for Notice

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 Notice

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Notice

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 Notice