Struct openrpc_types::ContentDescriptor

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

impl Clone for ContentDescriptor

fn clone(&self) -> ContentDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentDescriptor

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

Formats the value using the given formatter.

impl Default for ContentDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContentDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContentDescriptor

fn eq(&self, other: &ContentDescriptor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ContentDescriptor

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 ContentDescriptor