Struct Icon 

#[non_exhaustive]
pub struct Icon {
    pub src: String,
    pub mime_type: Option<MediaType>,
    pub sizes: Option<Vec<String>>,
    pub theme: Option<IconTheme>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

An optionally-sized icon that can be displayed in a user interface.

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.

src: String

A standard URI pointing to an icon resource.

mime_type: Option<MediaType>

Optional MIME type override if the source MIME type is missing or generic.

Omitted and null are equivalent and mean the source MIME type is used.

sizes: Option<Vec<String>>

Optional array of strings that specify sizes at which the icon can be used. Each string should be in WxH format (e.g., "48x48", "96x96") or "any" for scalable formats like SVG.

If not provided, the client should assume that the icon can be used at any size.

Omitted and null are equivalent and mean no sizes are specified.

theme: Option<IconTheme>

Optional theme this icon is designed for.

Omitted and null are equivalent and mean the icon is not theme-specific.

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 Icon

pub fn new(src: impl Into<String>) -> Icon

Builds Icon with the required source URI; optional display hints start unset.

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

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

pub fn mime_type(self, mime_type: impl IntoOption<MediaType>) -> Icon

Sets or clears the optional mimeType field.

pub fn sizes(self, sizes: impl IntoOption<Vec<String>>) -> Icon

Sets or clears the optional sizes at which the icon can be used.

pub fn theme(self, theme: impl IntoOption<IconTheme>) -> Icon

Sets or clears the optional theme field.

Trait Implementations

impl Clone for Icon

fn clone(&self) -> Icon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Icon

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Icon

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Icon

impl JsonSchema for Icon

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 Icon

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Icon

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 Icon