Struct astarte_device_sdk::interface::Interface

pub struct Interface { /* private fields */ }

Astarte interface implementation.

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

Implementations

impl Interface

pub fn interface_name(&self) -> &str

Returns the interface name.

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) -> InterfaceTypeDef

Returns the interface type.

pub fn ownership(&self) -> Ownership

Returns the interface ownership.

pub fn aggregation(&self) -> Aggregation

Returns the interface aggregation.

pub fn iter_mappings(&self) -> MappingIter<'_>

Returns an iterator over the interface’s mappings.

pub fn mappings_len(&self) -> usize

Returns the number of Mappings in the interface.

pub fn is_property(&self) -> bool

Check if the interface is a property.

pub fn is_object(&self) -> bool

Check if the interface is an object.

pub fn validate(&self) -> Result<(), InterfaceError>

Validate if an interface is valid

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

Validate if an interface is 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_prop(&self) -> Option<PropertyRef<'_>>

Returns a typed reference to a property, only if the interface is of type InterfaceTypeDef::Properties.

pub fn as_inner(&self) -> &InterfaceType

Returns a reference to the specific interface type.

See the documentation on InterfaceType for more information.

pub fn into_inner(self) -> InterfaceType

Returns the specific interface type.

See the documentation on InterfaceType for more information.

Trait Implementations

impl<'a> AsRef<Interface> for PropertyRef<'a>

fn as_ref(&self) -> &Interface

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Borrow<Interface> for PropertyRef<'a>

fn borrow(&self) -> &Interface

Immutably borrows from an owned value.

impl Clone for Interface

fn clone(&self) -> Interface

Returns a copy 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 FromStr for Interface

type Err = InterfaceError

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Interface