Enum nut_client::tokio::Connection

pub enum Connection {
    Tcp(TcpConnection),
}

An async NUT client connection.

Variants

Tcp

A TCP connection.

Tuple Fields of Tcp

0: TcpConnection

Implementations

impl Connection

pub async fn new(config: &Config) -> Result<Self>

Initializes a connection to a NUT server (upsd).

pub async fn close(self) -> Result<()>

Gracefully closes the connection.

impl Connection

pub async fn list_ups(&mut self) -> Result<Vec<(String, String)>>

Queries a list of UPS devices.

pub async fn list_clients(&mut self, ups_name: &str) -> Result<Vec<String>>

Queries the list of client IP addresses connected to the given device.

pub async fn list_vars(&mut self, ups_name: &str) -> Result<Vec<Variable>>

Queries the list of variables for a UPS device.

pub async fn list_mutable_vars(
    &mut self,
    ups_name: &str
) -> Result<Vec<Variable>>

Queries the list of mutable variables for a UPS device.

pub async fn list_commands(&mut self, ups_name: &str) -> Result<Vec<String>>

Queries the list of commands available for the given device.

pub async fn list_var_range(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<Vec<VariableRange>>

Queries the possible ranges of a UPS variable.

pub async fn list_var_enum(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<Vec<String>>

Queries the possible enum values of a UPS variable.

impl Connection

pub async fn get_var(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<Variable>

Queries one variable for a UPS device.

pub async fn get_var_description(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<String>

Queries the description of a UPS variable.

pub async fn get_var_type(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<VariableDefinition>

Queries the type of a UPS variable.

pub async fn get_command_description(
    &mut self,
    ups_name: &str,
    variable: &str
) -> Result<String>

Queries the description of a UPS command.

pub async fn get_ups_description(&mut self, ups_name: &str) -> Result<String>

Queries the description of a UPS device.

pub async fn get_num_logins(&mut self, ups_name: &str) -> Result<i32>

Queries the number of logins to the specified UPS.

impl Connection

pub async fn get_network_version(&mut self) -> Result<String>

Queries the network protocol version.

pub async fn get_server_version(&mut self) -> Result<String>

Queries the server NUT version.