Struct ResourceLink 

#[non_exhaustive]
pub struct ResourceLink {
    pub annotations: Option<Annotations>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub name: String,
    pub size: Option<i64>,
    pub title: Option<String>,
    pub uri: String,
    pub meta: Option<Meta>,
}

A resource that the server is capable of reading, included in 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.

description: Option<String>

Optional human-readable details shown with this protocol object.

mime_type: Option<String>

MIME type describing the encoded media payload.

name: String

Human-readable name shown for this protocol object.

size: Option<i64>

Optional size of the linked resource in bytes, if known.

title: Option<String>

Optional display title for end-user UI.

uri: String

URI associated with this resource or media payload.

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 ResourceLink

pub fn new(name: impl Into<String>, uri: impl Into<String>) -> Self

Builds ResourceLink 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 description(self, description: impl IntoOption<String>) -> Self

Sets or clears the optional description field.

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

Sets or clears the optional mimeType field.

pub fn size(self, size: impl IntoOption<i64>) -> Self

Sets or clears the optional size field.

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

Sets or clears the optional title 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 ResourceLink

fn clone(&self) -> ResourceLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceLink

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceLink

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV2 for ResourceLink

Available on crate feature unstable_protocol_v2 only.

type Output = ResourceLink

The corresponding v2 draft type.

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

Converts this value into the corresponding v2 draft type.

impl JsonSchema for ResourceLink

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 ResourceLink

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

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 ResourceLink