Struct Client 

pub struct Client {
    connection: Connection<Stream>,
}

Available on crate feature client only.

High-level LeLuM Varlink client.

This is a wrapper around LelumProxy that manages the underlying connection.

Fields

connection: Connection<Stream>

Implementations

impl Client

pub async fn connect_unix(path: &Path) -> Result<Self>

Connects to a LeLuM Varlink server at the given Unix socket path.

pub async fn health<'a>( &'a mut self, ) -> Result<Result<HealthReport, LelumError<'a>>>

Retrieves a health report from the Lelum service.

See com.inomotech.Lelum.Health for details.

pub async fn read<'a>( &'a mut self, path: &str, ) -> Result<Result<DataEntryValue, LelumError<'a>>>

Reads the current value of the data entry node at path.

See com.inomotech.Lelum.Read for details.

pub fn read_multiple<'s, 'p: 's, P>( &'s mut self, paths: P, ) -> impl Stream<Item = Result<Result<DataEntryValue, LelumError<'s>>>> + 's

where P: IntoIterator<Item = &'p str> + 'p,

Reads multiple data entries with a chain request.

The order of returned entries matches the order of requested paths.

See com.inomotech.Lelum.Read for details.

pub async fn try_read_multiple<'s, 'p, P>( &'s mut self, paths: P, ) -> Result<impl Stream<Item = Result<Result<DataEntryValue, LelumError<'s>>>> + 's>

where P: IntoIterator<Item = &'p str> + 'p,

Reads multiple data entries with a chain request.

Unlike Client::read_multiple, this method returns a Result indicating whether the chain request could be sent.

See com.inomotech.Lelum.Read for details.

pub fn query<'q>(&'q mut self) -> QueryBuilder<'q>

Returns a QueryBuilder to build a query request.

See com.inomotech.Lelum.Query for details.

pub async fn update( &mut self, path: &str, value: &Value, ) -> Result<Result<DataEntryValue, LelumError<'_>>>

Updates the value of the data entry node at path.

See com.inomotech.Lelum.Update for details.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.