Struct StateSocket 

pub struct StateSocket { /* private fields */ }

Implementations

impl StateSocket

pub async fn listen(&mut self, socket_file: PathBuf) -> Result<()>

Bind to Unix socket and listen.

Errors

Will error if build_listener() cannot be unwrapped or awaited. As in build_listener(), this is likely a filesystem issue, such as incorrect permissions or a non-existant file.

pub async fn shutdown(&mut self)

Explicitly shutdown StateSocket to perform cleanup.

pub async fn write_manager_state<H: Handle>( &mut self, raw_state: &State<H>, ) -> Result<()>

Errors

Will return Err if a mut ref to the peer is unavailable. Will return error if state cannot be serialized

Trait Implementations

impl Debug for StateSocket

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

Formats the value using the given formatter.

impl Default for StateSocket

fn default() -> StateSocket

Returns the “default value” for a type.

impl Drop for StateSocket

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.