Struct open_rpc::Link

pub struct Link {
    pub name: String,
    pub description: Option<String>,
    pub summary: Option<String>,
    pub method: Option<String>,
    pub params: Option<LinkParams>,
    pub server: Option<Server>,
}

Represents a possible design-time link for a result.

The presence of a link does not guarantee the caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between results and other methods.

Fields

name: String

Cannonical name for the link.

description: Option<String>

A description of the link.

GitHub Flavored Markdown syntax may be used for rich text representation.

summary: Option<String>

Short description for the link.

method: Option<String>

The name of an existing, resolvable OpenRPC method, as defined with a unique method. This field must resolve to a unique Method object.

params: Option<LinkParams>

The parameters to pass to a method as specified with method. The key is the parameter name to be used, whereas the value can be a constant or a RuntimeExpression to be evaluated and passed to the linked method.

server: Option<Server>

A server object to be used by the target method.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Link

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Link

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.