Skip to main content

Watchdog

Struct Watchdog 

Source
pub struct Watchdog { /* private fields */ }
Expand description

The armed budget’s watchdog thread; stops it when dropped.

Implementations§

Source§

impl Watchdog

Source

pub const fn budget(&self) -> &Budget

The armed budget, to hand to the run.

Source

pub fn finish(&mut self) -> Result<Option<Exhausted>, MeasurementError>

Checks the clock and takes the final memory sample before publishing a result. Only the watchdog’s owning entry point calls this; nested armed calls do not.

§Errors

Returns a typed failure when memory measurement is unavailable.

Trait Implementations§

Source§

impl Debug for Watchdog

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Watchdog

Source§

fn drop(&mut self)

Stops the watchdog. A sample in flight is not waited for: the thread sees the stop when the sample returns and exits by itself.

Source§

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. Read more

Auto Trait Implementations§

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, U> Into<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.