Struct ResourceTemplate 

pub struct ResourceTemplate {
    pub name: String,
    pub uri_template: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub annotations: Option<Annotations>,
    pub _meta: Option<Value>,
}

A template description for resources available on the server Supports RFC 6570 URI template expansion

Fields

name: String

Programmatic identifier

uri_template: String

URI template (RFC 6570)

title: Option<String>

Human-readable title

description: Option<String>

Description of what this template is for

mime_type: Option<String>

MIME type for all resources matching this template (if uniform)

annotations: Option<Annotations>

Optional annotations

_meta: Option<Value>

Optional metadata

Implementations

impl ResourceTemplate

pub fn new<N: Into<String>, U: Into<String>>(name: N, uri_template: U) -> Self

Create a new resource template

pub fn with_title<T: Into<String>>(self, title: T) -> Self

Set the title

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

Set the description

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

Set the MIME type

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

Set annotations

pub fn with_meta(self, meta: Value) -> Self

Add metadata

pub fn file_system<N: Into<String>>(name: N, base_path: &str) -> Self

Create a file system template

pub fn api_endpoint<N: Into<String>>(name: N, base_url: &str) -> Self

Create an API endpoint template

pub fn database_query<N: Into<String>>(name: N) -> Self

Create a database query template

Trait Implementations

impl Clone for ResourceTemplate

fn clone(&self) -> ResourceTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceTemplate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResourceTemplate

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

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 ResourceTemplate