Struct pgdo::coordinate::guard::Guard

pub struct Guard<SUBJECT>
where
    SUBJECT: Subject,
{ /* private fields */ }

Smart pointer around a Subject that ensures the subject is stopped or destroyed when it goes out of scope.

Errors when stopping or destroying the subject are logged but otherwise ignored.

Implementations

impl<T> Guard<T>

where T: Subject,

pub fn startup<L: Into<UnlockedFile>>( lock: L, subject: T, options: T::Options<'_> ) -> Result<Self, CoordinateError<T::Error>>

Starts the given subject and returns the guard.

impl<T> Guard<T>

where T: Subject,

pub fn and_stop(self) -> Self

Configures the guard to stop the subject when it goes out of scope.

pub fn and_destroy(self) -> Self

Configures the guard to destroy the subject when it goes out of scope.

Trait Implementations

impl<T> Drop for Guard<T>

where T: Subject,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Deref for Guard<T>

where T: Subject,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.