Struct Interface 

pub struct Interface { /* private fields */ }

Astarte interface implementation.

Should be used only through its conversion methods, not instantiated directly.

Implementations

impl Interface

pub fn inner(&self) -> &InterfaceTypeAggregation

Returns the inner enum of the InterfaceTypeAggregation

pub fn interface_name(&self) -> &str

Returns the interface name.

pub fn version(&self) -> InterfaceVersion

Returns the interface version.

pub fn version_major(&self) -> i32

Returns the interface major version.

pub fn version_minor(&self) -> i32

Returns the interface minor version.

pub fn interface_type(&self) -> InterfaceType

Returns the interface type.

pub fn ownership(&self) -> Ownership

Returns the interface ownership.

pub fn aggregation(&self) -> Aggregation

Returns the interface aggregation.

pub fn validate_with(&self, prev: &Self) -> Result<&Self, Error>

Validate an interface given the previous version prev.

It will check whether:

• Both the versions are valid
• The name of the interface is the same
• The new version is a valid successor of the previous version.

pub fn as_datastream_individual(&self) -> Option<&DatastreamIndividual>

Return a reference to a DatastreamIndividual.

pub fn as_datastream_object(&self) -> Option<&DatastreamObject>

Return a reference to a DatastreamObject.

pub fn as_properties(&self) -> Option<&Properties>

Return a reference to a Properties.

pub fn is_datastream_individual(&self) -> bool

Returns true if the interface type is DatastreamIndividual.

pub fn is_datastream_object(&self) -> bool

Returns true if the interface type is DatastreamObject.

pub fn is_properties(&self) -> bool

Returns true if the interface type is Properties.

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Interface

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Interface

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

Formats the value using the given formatter.

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 FromStr for Interface

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Interface

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

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 Eq for Interface

impl StructuralPartialEq for Interface