Struct EscrowOperation 

pub struct EscrowOperation { /* private fields */ }

Holds the process lifecycle channel (or optionally just the control side of it), and uses it to send escrow data and handles to component manager. This is a required step for a component to gracefully shut itself down when it would otherwise sit idle, in order to save system resources.

Implementations

impl EscrowOperation

pub fn new() -> Self

Creates a new EscrowOperation by taking the process lifecycle handle. Does not actually perform the escrow operation, see Self::run.

pub fn new_with_lifecycle_handle( lifecycle_handle: ServerEnd<LifecycleMarker>, ) -> Self

Creates a new EscrowOperation with the provided process lifecycle handle. Does not actually perform the escrow operation, see Self::run.

pub fn new_with_control_handle(control_handle: LifecycleControlHandle) -> Self

Creates a new EscrowOperation with the provided process lifecycle control handle. Does not actually perform the escrow operation, see Self::run.

pub fn with_fsandbox_dictionary(&self, fsandbox_dictionary: DictionaryRef)

Adds a dictionary handle to the escrow operation, which will be returned to us when if/when we are restarted.

Deprecated, prefer with_dictionary.

pub fn with_dictionary(&self, dictionary: Dictionary)

Adds a dictionary handle to the escrow operation, which will be returned to us when if/when we are restarted.

pub fn watch_for_stop(&self) -> Result<(), Error>

Starts a new async task that watches the process lifecycle handle for a stop instruction, and exits this process if/when such a signal is received.

pub fn run( &self, outgoing_directory: ServerEnd<DirectoryMarker>, ) -> Result<(), Error>

Runs this escrow operation, sending the outgoing directory and potentially a dictionary handle to component manager. The component should exit immediately after calling this function.

Trait Implementations

impl Clone for EscrowOperation

fn clone(&self) -> EscrowOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for EscrowOperation

fn default() -> EscrowOperation

Returns the “default value” for a type.