Struct ResourceDescriptor 

pub struct ResourceDescriptor {
    pub id: ResourceId,
    pub name: String,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub metadata: MetadataMap,
}

Describes a resource that a ResourceProvider can serve.

Resource descriptors are returned by ResourceProvider::list_resources so that the host or model can discover what data is available and request it by ResourceId.

Fields

id: ResourceId

Unique identifier used to request this resource.

name: String

A short, human-readable name for the resource.

description: Option<String>

An optional longer description of the resource contents.

mime_type: Option<String>

The MIME type of the resource data (e.g. "text/plain", "application/json").

metadata: MetadataMap

Arbitrary key-value metadata attached to the descriptor.

Implementations

impl ResourceDescriptor

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

Builds a resource descriptor with no description or mime type.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

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

Sets the mime type.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the descriptor metadata.

Trait Implementations

impl Clone for ResourceDescriptor

fn clone(&self) -> ResourceDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResourceDescriptor

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ResourceDescriptor

impl StructuralPartialEq for ResourceDescriptor