Struct reopen::Handle

pub struct Handle(_);

A handle to signal a companion Reopen object to do a reopen on its next operation.

Cloning creates interchangeable handles (they all control the same Reopen). Cloning is cheap (it’s only an Arc in disguise).

Implementations

impl Handle

pub fn register_signal(&self, signal: c_int) -> Result<SigId, Error>

Installs a signal handler to invoke the reopening when a certain signal comes.

Features

This is available only with the signals feature enabled.

Notes

• Under the hood, this uses the signal-hook crate, so the same signal can be shared with other actions (to eg. also reload a configuration).
• The same restrictions, errors and panics as in the case of signal_hook::register apply.
• This installs a signal handler. Signal handlers are program-global entities, so you may be careful.
• If there are multiple handles for the same signal, they share their signal handler ‒ only the first one for each signal registers one.
• Upon signal registration, the original handler is stored and called in chain from our own signal handler.
• A single handle can be used for multiple signals.
• To unregister a handle from a signal handle, use the returned SigId and the signal_hook::unregister.

impl Handle

pub fn reopen(&self)

Signals the companion Reopen object to do a reopen on its next operation.

pub fn stub() -> Self

Creates an unpaired handle, not connected to any [‘Reopen’].

It can be added to a new Reopen later on with with_handle.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.