Struct BlobResourceContents 

#[non_exhaustive]
pub struct BlobResourceContents {
    pub blob: String,
    pub mime_type: Option<String>,
    pub uri: String,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Binary resource contents.

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.

blob: String

Base64-encoded bytes for a binary resource payload.

mime_type: Option<String>

MIME type describing the encoded media payload.

uri: String

URI associated with this resource or media payload.

meta: Option<Map<String, Value>>

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

Implementations

impl BlobResourceContents

pub fn new( blob: impl Into<String>, uri: impl Into<String>, ) -> BlobResourceContents

Builds BlobResourceContents with its required content payload; optional annotations and metadata start unset.

pub fn mime_type( self, mime_type: impl IntoOption<String>, ) -> BlobResourceContents

Sets or clears the optional mimeType field.

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

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

Trait Implementations

impl Clone for BlobResourceContents

fn clone(&self) -> BlobResourceContents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlobResourceContents

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlobResourceContents

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for BlobResourceContents

type Output = BlobResourceContents

The corresponding v1 type.

fn into_v1( self, ) -> Result<<BlobResourceContents as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonSchema for BlobResourceContents

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 BlobResourceContents

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BlobResourceContents

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 BlobResourceContents