Skip to main content

Resource

Struct Resource 

Source
pub struct Resource {
    pub uri: String,
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub icons: Option<Vec<ToolIcon>>,
    pub size: Option<u64>,
    /* private fields */
}
Expand description

A complete resource definition with service-based execution.

Resources are implemented as Tower services internally, enabling middleware composition via the builder’s .layer() method. The service is wrapped in ResourceCatchError to convert any errors (from handlers or middleware) into error result responses.

Fields§

§uri: String

Resource URI

§name: String

Human-readable name

§title: Option<String>

Human-readable title for display purposes

§description: Option<String>

Optional description

§mime_type: Option<String>

Optional MIME type

§icons: Option<Vec<ToolIcon>>

Optional icons for display in user interfaces

§size: Option<u64>

Optional size in bytes

Implementations§

Source§

impl Resource

Source

pub fn builder(uri: impl Into<String>) -> ResourceBuilder

Create a new resource builder

Source

pub fn definition(&self) -> ResourceDefinition

Get the resource definition for resources/list

Source

pub fn read(&self) -> BoxFuture<'static, ReadResourceResult>

Read the resource without context

Creates a dummy request context. For full context support, use read_with_context.

Source

pub fn read_with_context( &self, ctx: RequestContext, ) -> BoxFuture<'static, ReadResourceResult>

Read the resource with request context

The context provides progress reporting, cancellation support, and access to client requests (for sampling, etc.).

§Note

This method returns ReadResourceResult directly (not Result<ReadResourceResult>). Any errors from the handler or middleware are converted to error responses in the result contents.

Trait Implementations§

Source§

impl Clone for Resource

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Resource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Filterable for Resource

Source§

fn name(&self) -> &str

Returns the name of this capability.
Source§

impl Send for Resource

Source§

impl Sync for Resource

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more