Struct Guard

Source

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

Expand description

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§

Source §

impl<T> Guard<T>
where T: Subject,

Source

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.

Source §

impl<T> Guard<T>
where T: Subject,

Source

pub fn and_stop(self) -> Self

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

Source

pub fn and_destroy(self) -> Self

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

Trait Implementations§

Source §

impl<T> Deref for Guard<T>
where T: Subject,

Source §

type Target = T

The resulting type after dereferencing.

Source §

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

Dereferences the value.

Source §

impl<T> Drop for Guard<T>
where T: Subject,

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<SUBJECT> UnwindSafe for Guard<SUBJECT>
where SUBJECT: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §