rust_mcp_sdk::schema

Struct StringSchema

pub struct StringSchema {
    pub description: Option<String>,
    pub format: Option<StringSchemaFormat>,
    pub max_length: Option<i64>,
    pub min_length: Option<i64>,
    pub title: Option<String>,
    /* private fields */
}

Expand description

StringSchema

JSON schema

{
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "description": {
     "type": "string"
   },
   "format": {
     "type": "string",
     "enum": [
       "date",
       "date-time",
       "email",
       "uri"
     ]
   },
   "maxLength": {
     "type": "integer"
   },
   "minLength": {
     "type": "integer"
   },
   "title": {
     "type": "string"
   },
   "type": {
     "type": "string",
     "const": "string"
   }
 }
}

Fields§

§description: Option<String>§format: Option<StringSchemaFormat>§max_length: Option<i64>§min_length: Option<i64>§title: Option<String>

Implementations§

impl StringSchema

pub fn new( description: Option<String>, format: Option<StringSchemaFormat>, max_length: Option<i64>, min_length: Option<i64>, title: Option<String>, ) -> StringSchema

pub fn type_(&self) -> &String

pub fn type_name() -> String

Trait Implementations§

impl Clone for StringSchema

fn clone(&self) -> StringSchema

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for StringSchema

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for StringSchema

fn deserialize<D>( deserializer: D, ) -> Result<StringSchema, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<StringSchema> for PrimitiveSchemaDefinition

fn from(value: StringSchema) -> PrimitiveSchemaDefinition

Converts to this type from the input type.

impl Serialize for StringSchema

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for StringSchema

impl RefUnwindSafe for StringSchema

impl Send for StringSchema

impl Sync for StringSchema

impl Unpin for StringSchema

impl UnwindSafe for StringSchema

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,