Struct openrpc_types::ContentDescriptor
source · pub struct ContentDescriptor {
pub name: String,
pub summary: Option<String>,
pub description: Option<String>,
pub required: Option<bool>,
pub schema: Schema,
pub deprecated: Option<bool>,
pub extensions: SpecificationExtensions,
}
Fields§
§name: String
REQUIRED. Name of the content that is being described. If the content described is a method parameter assignable by-name, this field SHALL define the parameter’s key (ie name).
summary: Option<String>
A short summary of the content that is being described.
description: Option<String>
A verbose explanation of the content descriptor behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.
required: Option<bool>
Determines if the content is a required field. Default value is
false
.
schema: Schema
REQUIRED. Schema that describes the content.
The Schema Object allows the definition of input and output data types. The Schema Objects MUST follow the specifications outline in the JSON Schema Specification 7 Alternatively, any time a Schema Object can be used, a Reference Object can be used in its place. This allows referencing definitions instead of defining them inline.
This object MAY be extended with Specification Extensions.
deprecated: Option<bool>
Specifies that the content is deprecated and SHOULD be transitioned out of usage. Default value is
false
.
extensions: SpecificationExtensions
Trait Implementations§
source§impl Clone for ContentDescriptor
impl Clone for ContentDescriptor
source§fn clone(&self) -> ContentDescriptor
fn clone(&self) -> ContentDescriptor
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ContentDescriptor
impl Debug for ContentDescriptor
source§impl Default for ContentDescriptor
impl Default for ContentDescriptor
source§impl<'de> Deserialize<'de> for ContentDescriptor
impl<'de> Deserialize<'de> for ContentDescriptor
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl PartialEq for ContentDescriptor
impl PartialEq for ContentDescriptor
source§fn eq(&self, other: &ContentDescriptor) -> bool
fn eq(&self, other: &ContentDescriptor) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for ContentDescriptor
impl Serialize for ContentDescriptor
impl StructuralPartialEq for ContentDescriptor
Auto Trait Implementations§
impl Freeze for ContentDescriptor
impl RefUnwindSafe for ContentDescriptor
impl Send for ContentDescriptor
impl Sync for ContentDescriptor
impl Unpin for ContentDescriptor
impl UnwindSafe for ContentDescriptor
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)