Struct Resource

pub struct Resource {
    pub annotations: Option<Annotations>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub name: String,
    pub size: Option<i64>,
    pub uri: String,
}

A known resource that the server is capable of reading.

JSON schema

{
 "description": "A known resource that the server is capable of reading.",
 "type": "object",
 "required": [
   "name",
   "uri"
 ],
 "properties": {
   "annotations": {
     "description": "Optional annotations for the client.",
     "$ref": "#/definitions/Annotations"
   },
   "description": {
     "description": "A description of what this resource represents.\n\nThis can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a \"hint\" to the model.",
     "type": "string"
   },
   "mimeType": {
     "description": "The MIME type of this resource, if known.",
     "type": "string"
   },
   "name": {
     "description": "A human-readable name for this resource.\n\nThis can be used by clients to populate UI elements.",
     "type": "string"
   },
   "size": {
     "description": "The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.\n\nThis can be used by Hosts to display file sizes and estimate context window usage.",
     "type": "integer"
   },
   "uri": {
     "description": "The URI of this resource.",
     "type": "string",
     "format": "uri"
   }
 }
}

Fields

annotations: Option<Annotations>

Optional annotations for the client.

description: Option<String>

A description of what this resource represents.

This can be used by clients to improve the LLM’s understanding of available resources. It can be thought of like a “hint” to the model.

mime_type: Option<String>

The MIME type of this resource, if known.

name: String

A human-readable name for this resource.

This can be used by clients to populate UI elements.

size: Option<i64>

The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.

This can be used by Hosts to display file sizes and estimate context window usage.

uri: String

The URI of this resource.

Implementations

impl Resource

pub fn new(uri: &str, name: &str) -> Self

pub fn with_description(self, description: &str) -> Self

pub fn with_mime_type(self, mime_type: &str) -> Self

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

pub fn with_size(self, size: i64) -> Self

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Resource> for Resource

fn from(value: &Resource) -> Self

Converts to this type from the input type.

impl PartialEq for Resource

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

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 Resource