Struct EmbeddedResource 

#[non_exhaustive]
pub struct EmbeddedResource {
    pub annotations: Option<Annotations>,
    pub resource: EmbeddedResourceResource,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

The contents of a resource, embedded into a prompt or tool call result.

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.

annotations: Option<Annotations>

Optional annotations that help clients decide how to display or route this content.

resource: EmbeddedResourceResource

Embedded resource payload, either text or binary data.

meta: Option<Meta>

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 EmbeddedResource

pub fn new(resource: EmbeddedResourceResource) -> Self

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

pub fn annotations(self, annotations: impl IntoOption<Annotations>) -> Self

Sets or clears the optional annotations field.

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

See protocol docs: Extensibility

Trait Implementations

impl Clone for EmbeddedResource

fn clone(&self) -> EmbeddedResource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddedResource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbeddedResource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for EmbeddedResource

type Output = EmbeddedResource

The corresponding v1 type.

fn into_v1(self) -> Result<Self::Output>

Converts this value into the corresponding v1 type.

impl JsonSchema for EmbeddedResource

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 EmbeddedResource

fn eq(&self, other: &EmbeddedResource) -> 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 EmbeddedResource

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 EmbeddedResource