Struct MethodDescription

struct MethodDescription {
    method_type: String,
    output_type: String,
    update_type: Option<String>,
    applies_to_object_types: BTreeSet<String>,
}

Available on crate feature describe-methods only.

A table describing, for a single RPC method, which types it expects and returns, and which objects it applies to.

This is, for now, a serialize-only type; it does nothing else.

See RpcDispatchInformation for caveats about type names.

Fields

method_type: String

The type representing an invocation of this method.

Its fields are the method’s parameters.

output_type: String

The type that this method returns on successful completion.

update_type: Option<String>

The type (if any) that this method delivers as an incremental status update.

applies_to_object_types: BTreeSet<String>

A list of the types of Objects that this method can be applied to.

Implementations

impl MethodDescription

fn new(method_type_name: &str, info: &MethodInfo_) -> Self

Construct a new MethodDescription.

fn push_object_type(&mut self, object_type_name: &str)

Add object_type_name to the list of object types this method applies to.

Trait Implementations

impl Clone for MethodDescription

fn clone(&self) -> MethodDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MethodDescription

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

Formats the value using the given formatter.

impl Serialize for MethodDescription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.