Struct ExamplePairing

pub struct ExamplePairing {
    pub name: String,
    pub description: Option<String>,
    pub summary: Option<String>,
    pub params: Vec<ReferenceOr<Example>>,
    pub result: Option<ReferenceOr<Example>>,
    pub extensions: SpecificationExtensions,
}

The Example Pairing object consists of a set of example params and result. The result is what you can expect from the JSON-RPC service given the exact params.

Fields

name: String

REQUIRED Name for the example pairing.

description: Option<String>

A verbose explanation of the example pairing.

summary: Option<String>

Short description for the example pairing.

params: Vec<ReferenceOr<Example>>

REQUIRED Example parameters.

result: Option<ReferenceOr<Example>>

Example result. When undefined, the example pairing represents usage of the method as a notification.

extensions: SpecificationExtensions

Trait Implementations

impl Clone for ExamplePairing

fn clone(&self) -> ExamplePairing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExamplePairing

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

Formats the value using the given formatter.

impl Default for ExamplePairing

fn default() -> ExamplePairing

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExamplePairing

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExamplePairing

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

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 ExamplePairing