Struct InterfaceJson 

pub struct InterfaceJson<T>
where
    T: AsRef<str>,
{ /* private fields */ }

The structure is a direct mapping of the JSON schema, they are then transformed in our internal representation of Interface when de-serializing using TryFrom.

The fields of the JSON can either be:

• Required: the field is the value it represents, it cannot be omitted.
• Optional with default: the field is optional, but it is value it represents (not wrapped in Option). It will not be serialized if the value is the default one.
• Optional: the field is optional, it is wrapped in Option. It will not be serialized if the value is None.

Implementations

impl<T> InterfaceJson<T>

where T: AsRef<str>,

pub fn interface_name(&self) -> &str

The name of the interface.

This has to be an unique, alphanumeric reverse internet domain name, shorter than 128 characters.

pub fn version_major(&self) -> i32

The Major version qualifier for this interface.

Interfaces with the same id and different version_major number are deemed incompatible. It is then acceptable to redefine any property of the interface when changing the major version number.

It must be a positive number.

pub fn version_minor(&self) -> i32

The Minor version qualifier for this interface.

Interfaces with the same id and major version number and different version_minor number are deemed compatible between each other. When changing the minor number, it is then only possible to insert further mappings. Any other modification might lead to incompatibilities and undefined behavior.

It must be a positive number.

pub fn interface_type(&self) -> InterfaceType

Identifies the type of this Interface.

Currently two types are supported: datastream and properties. Datastream should be used when dealing with streams of non-persistent data, where a single path receives updates and there’s no concept of state. Properties, instead, are meant to be an actual state and as such they have only a change history, and are retained.

pub fn ownership(&self) -> Ownership

Identifies the direction of the interface.

Interfaces are meant to be unidirectional, and this property defines who’s sending or receiving data. device means the device/gateway is sending data to Astarte, consumer means the device/gateway is receiving data from Astarte. Bidirectional mode is not supported, you should instantiate another interface for that.

pub fn aggregation(&self) -> Option<Aggregation>

Identifies the aggregation of the mappings of the interface.

Individual means every mapping changes state or streams data independently, whereas an object aggregation treats the interface as an object, making all the mappings changes interdependent. Choosing the right aggregation might drastically improve performances.

pub fn description(&self) -> Option<&T>

An optional description of the interface.

pub fn doc(&self) -> Option<&T>

A string containing documentation that will be injected in the generated client code.

pub fn mappings(&self) -> &[Mapping<T>]

Mappings define the endpoint of the interface, where actual data is stored/streamed.

They are defined as relative URLs (e.g. /my/path) and can be parametrized (e.g.: /%{myparam}/path). A valid interface must have no mappings clash, which means that every mapping must resolve to a unique path or collection of paths (including parametrization). Every mapping acquires type, quality and aggregation of the interface.

Trait Implementations

impl<T> Clone for InterfaceJson<T>

where T: AsRef<str> + Clone,

fn clone(&self) -> InterfaceJson<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for InterfaceJson<T>

where T: AsRef<str> + Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for InterfaceJson<T>

where T: AsRef<str> + Deserialize<'de> + Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Interface> for InterfaceJson<Cow<'a, str>>

fn from(value: &'a Interface) -> Self

Converts to this type from the input type.

impl<'a, T> From<&'a T> for InterfaceJson<Cow<'a, str>>

where T: Schema,

fn from(value: &'a T) -> Self

Converts to this type from the input type.

impl<T> PartialEq for InterfaceJson<T>

where T: AsRef<str> + PartialEq,

fn eq(&self, other: &InterfaceJson<T>) -> 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<T> Serialize for InterfaceJson<T>

where T: AsRef<str> + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFrom<InterfaceJson<T>> for DatastreamIndividual

where T: AsRef<str> + Into<String>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: InterfaceJson<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<InterfaceJson<T>> for DatastreamObject

where T: AsRef<str> + Into<String>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: InterfaceJson<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<InterfaceJson<T>> for Interface

where T: AsRef<str> + Into<String>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: InterfaceJson<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<InterfaceJson<T>> for Properties

where T: AsRef<str> + Into<String>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: InterfaceJson<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> Eq for InterfaceJson<T>

where T: AsRef<str> + Eq,

impl<T> StructuralPartialEq for InterfaceJson<T>

where T: AsRef<str>,