Struct Device 

pub struct Device { /* private fields */ }

A tosca device.

Implementations

impl Device

pub fn new( network_info: NetworkInformation, description: Description, route_configs: RouteConfigs, ) -> Self

Creates a Device from NetworkInformation, Description, and RouteConfigs.

This method can be useful when creating a device from data stored in a database.

pub const fn network_info(&self) -> &NetworkInformation

Returns an immutable reference to NetworkInformation.

pub const fn description(&self) -> &Description

Returns an immutable reference to Description.

pub fn events_metadata(&self) -> Option<&EventsDescription>

Returns an immutable reference to EventsDescription.

If None, the device does not support events.

pub fn requests_info(&self) -> Vec<RequestInfo<'_>>

Returns a RequestInfo vector containing the information for each request.

pub fn requests_count(&self) -> usize

Returns the total number of requests associated with the device.

pub fn request(&self, route: &str) -> Option<&Request>

Returns the Request associated with the given route.

If None, the given route does not exist.

pub const fn has_events(&self) -> bool

Checks if a Device supports events.

pub const fn is_event_receiver_running(&self) -> bool

Checks if the event receiver is currently running.

Always returns false if the Device does not support events.

pub async fn start_event_receiver( &mut self, id: usize, buffer_size: usize, ) -> Result<Receiver<ToscaEvents>>

Starts the asynchronous event receiver if the Device supports events.

An event receiver task connects to the broker of a device and subscribes to its topic. When a device transmits an event to the broker, the task retrieves the event payload from the broker, parses the data, and sends the relevant content to the Receiver returned by this method.

The buffer_size parameter specifies how many messages the event receiver buffer can hold. When the buffer is full, subsequent send attempts will wait until a message is consumed from the channel.

When the returned Receiver is dropped, the event receiver task terminates automatically.

Errors

• The device does not support events
• The event receiver task has already been started
• An error occurred while attempting to subscribe to the broker topic

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.

impl PartialEq for Device

fn eq(&self, other: &Self) -> 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 Device

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

where __S: Serializer,

Serialize this value into the given Serde serializer.