Crate pueue_lib 

Pueue-lib

This is the shared library used by the Pueue client and daemon.

It contains everything you need to communicate with the daemon:

• The State, which represents the current state of the daemon as exposed to clients.
• The Task, TaskResult and TaskStatus
• The Settings used by both clients and the daemon.
• async and blocking Network code. Everything you need to communicate with the daemon.
  • Request and Response message types.
  • network::send_request and network::receive_response helper functions.
• A reference Client implementation. This is available with the client feature. The client also implements Client::send_request and Client::receive_response.

It also contains helper functions to read local logs.

Pueue-lib is a stand-alone crate, so it can be used by third-party applications to either manipulate or monitor the daemon or to simply write your own front-end for the daemon.

Features

For a minimal setup, disable default features and enable client and network or network_blocking.

• client Adds a Client and/or BlockingClient implementation, depending on whether network and/or network_blocking features are active.
• network adds async network and protocol functions.
• network_blocking adds blocking std network and protocol functions.
• log adds functions for reading pueue’s log files on the local machine.
• settings Settings struct used by both the daemon and client.

Re-exports

pub use error::Error;

pub use message::Request;

pub use message::Response;

pub use network::client::Client;

pub use network_blocking::client::BlockingClient;

pub use settings::Settings;

pub use state::Group;

pub use state::GroupStatus;

pub use state::State;

pub use task::Task;

pub use task::TaskResult;

pub use task::TaskStatus;

Modules

error

Pueue-lib errors.

log

Helper classes to read and write log files of Pueue’s tasks.

message

This contains the the Request and Response enums and all their structs used to communicate with the daemon or client.

network

This module contains everything that’s necessary to communicate with the pueue daemon or one of its clients.

network_blocking

This module contains everything that’s necessary to communicate with the pueue daemon or one of its clients.

prelude

secret

Functions to write and read the secret to/from a file.

settings

Pueue’s configuration file representation.

state

The representation of the pueue daemon’s current State. Contains all Tasks and Groups of the daemon.

task

Everything regarding Pueue’s Tasks.

tls

Helper functions for reading and handling TLS certificates.

Macros

failure_msg

Macro to simplify creating failure_messages

success_msg

Macro to simplify creating success_messages

Constants

PROTOCOL_VERSION