Struct SchemaReport

pub struct SchemaReport {
    pub types: HashSet<OwnedNamedType>,
    pub topics_in: Vec<TopicReport>,
    pub topics_out: Vec<TopicReport>,
    pub endpoints: Vec<EndpointReport>,
}

A report describing the schema spoken by the connected device

Fields

types: HashSet<OwnedNamedType>

All custom types spoken by the device (on any endpoint or topic), as well as all primitive types. In the future, primitive types may be removed.

topics_in: Vec<TopicReport>

All incoming (client to server) topics reported by the device

topics_out: Vec<TopicReport>

All outgoing (server to client) topics reported by the device

endpoints: Vec<EndpointReport>

All endpoints reported by the device

Implementations

impl SchemaReport

pub fn add_type(&mut self, t: OwnedNamedType)

Insert a new type

pub fn add_topic_in( &mut self, path: String, key: Key, ) -> Result<(), UnableToFindType>

Insert a new incoming (client to server) topic

Returns an error if we are unable to find the type used for this topic

pub fn add_topic_out( &mut self, path: String, key: Key, ) -> Result<(), UnableToFindType>

Insert a new outgoing (server to client) topic

Returns an error if we are unable to find the type used for this topic

pub fn add_endpoint( &mut self, path: String, req_key: Key, resp_key: Key, ) -> Result<(), UnableToFindType>

Insert a new endpoint

Returns an error if we are unable to find the type used for the request/response

Trait Implementations

impl Clone for SchemaReport

fn clone(&self) -> SchemaReport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaReport

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

Formats the value using the given formatter.

impl Default for SchemaReport

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SchemaReport

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

const SCHEMA: &'static NamedType

A recursive data structure that describes the schema of the given type.

impl Serialize for SchemaReport

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 SchemaReport