Struct rtrtr::comms::Link

pub struct Link { /* private fields */ }

A link to another unit.

The link allows tracking of updates of that other unit. This happens via the query method. A link’s owner can signal that they are currently not interested in receiving updates via the suspend method. This suspension will automatically be lifted the next time query is called.

Links can be created from the name of the unit they should be linking to via manager::load_link. This function is also called implicitly through the impls for Deserialize and From. Note, however, that the function only adds the link to a list of links to be properly connected by the manager later.

Implementations

impl Link

pub async fn query(&mut self) -> Result<Update, UnitStatus>

Query for the next update.

The method returns a future that resolves into the next update. The future can be dropped safely at any time.

The future either resolves into a payload update or the connected unit’s new status as the error variant. The current status is also available via the get_status method.

If the link is currently suspended, calling this method will lift the suspension.

pub async fn query_suspended(&mut self) -> UnitStatus

Query a suspended link.

When a link is suspended, it still received updates to the unit’s status. These updates can also be queried for explicitly via this method.

Much like query, the future returned by this method can safely be dropped at any time.

pub async fn suspend(&mut self)

Suspends the link.

A suspended link will not receive any payload updates from the connected unit. It will, however, still receive status updates.

The suspension is lifted automatically the next time query is called.

Note that this is an async method that needs to be awaited in order to do anything.

pub fn get_status(&self) -> UnitStatus

Returns the current status of the connected unit.

Trait Implementations

impl Debug for Link

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Link

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Marked<String>> for Link

fn from(name: Marked<String>) -> Self

Converts to this type from the input type.

impl From<String> for Link

fn from(name: String) -> Self

Converts to this type from the input type.