Struct openrpc_types::Method

pub struct Method {

    pub name: String,
    pub tags: Option<Vec<ReferenceOr<Tag>>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDocumentation>,
    pub params: Vec<ReferenceOr<ContentDescriptor>>,
    pub result: Option<ReferenceOr<ContentDescriptor>>,
    pub deprecated: Option<bool>,
    pub servers: Option<Vec<Server>>,
    pub errors: Option<Vec<ReferenceOr<Error>>>,
    pub param_structure: Option<ParamStructure>,
    pub examples: Option<Vec<ReferenceOr<ExamplePairing>>>,
    pub extensions: SpecificationExtensions,
}

Describes the interface for the given method name. The method name is used as the method field of the JSON-RPC body. It therefore MUST be unique.

Fields

name: String

REQUIRED. The cannonical name for the method. The name MUST be unique within the methods array.

tags: Option<Vec<ReferenceOr<Tag>>>

A list of tags for API documentation control. Tags can be used for logical grouping of methods by resources or any other qualifier.

summary: Option<String>

A short summary of what the method does.

description: Option<String>

A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.

external_docs: Option<ExternalDocumentation>

Additional external documentation for this method.

params: Vec<ReferenceOr<ContentDescriptor>>

REQUIRED. A list of parameters that are applicable for this method. The list MUST NOT include duplicated parameters and therefore require name to be unique. The list can use the Reference Object to link to parameters that are defined by the Content Descriptor Object. All optional params (content descriptor objects with “required”: false) MUST be positioned after all required params in the list.

result: Option<ReferenceOr<ContentDescriptor>>

The description of the result returned by the method. If defined, it MUST be a Content Descriptor or Reference Object. If undefined, the method MUST only be used as a notification.

deprecated: Option<bool>

Declares this method to be deprecated. Consumers SHOULD refrain from usage of the declared method. Default value is false.

servers: Option<Vec<Server>>

An alternative servers array to service this method. If an alternative servers array is specified at the Root level, it will be overridden by this value.

errors: Option<Vec<ReferenceOr<Error>>>

A list of custom application defined errors that MAY be returned. The Errors MUST have unique error codes.

param_structure: Option<ParamStructure>

examples: Option<Vec<ReferenceOr<ExamplePairing>>>

Array of Example Pairing Objects where each example includes a valid params-to-result Content Descriptor pairing.

extensions: SpecificationExtensions

Trait Implementations

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Method

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

Formats the value using the given formatter.

impl Default for Method

fn default() -> Method

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Method

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Method

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

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 Method