Struct Descriptor 

pub struct Descriptor {
    pub address: String,
    pub kind: AddressKind,
    pub doc: String,
    pub shape: Value,
    pub reply: Option<Value>,
    pub interfaces: Vec<String>,
}

An address’s descriptor.

Fields

address: String

kind: AddressKind

doc: String

shape: Value

The payload’s shape (yog_data::Shape::describe).

reply: Option<Value>

A service’s reply’s shape.

interfaces: Vec<String>

The interfaces it implements (yog:energy/storage): what Find finds it by.

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl Fields for Descriptor

const FIELDS: &'static [(&'static str, &'static str)]

impl PartialEq for Descriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for Descriptor

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(__yog_d: &mut Decoder<'_>) -> Option<Descriptor>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<Descriptor>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Descriptor>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl Service for Descriptor

const ADDRESS: &'static str = ids::service_bus::DECLARE

Where it’s provided.

const KEY: Option<&'static str> = None

The field whose value picks the provider’s branch (block_id: each block answers its own), if it’s keyed — see crate::keyed.

type Reply = bool

What the provider answers.

fn key(&self) -> Option<&str>

The key field’s value, if it’s keyed.

fn address(&self) -> u32

Service::target’s number — the type’s own address cached.

fn target(&self) -> String

Where this call goes: the address, or its branch for the key.

impl StructuralPartialEq for Descriptor