Struct Watchdog

Source
pub struct Watchdog<I, const N: usize, W, C>
where I: Id, W: HardwareWatchdog<C>, C: Clock,
{ /* private fields */ }
Expand description

A version of the Watchdog that doesn’t require heap allocation. This uses a fixed-size array for task storage.

Implementations§

Source§

impl<I: Id, W: HardwareWatchdog<C>, C: Clock, const N: usize> Watchdog<I, N, W, C>

Source

pub fn new(hw_watchdog: W, config: WatchdogConfig<C>, clock: C) -> Self

Create a new watchdog with the given hardware watchdog and configuration.

Arguments:

  • hw_watchdog - The hardware watchdog to use.
  • config - The configuration for the watchdog.
  • clock - The clock implementation to use for time-keeping.
Source

pub fn register_task( &mut self, id: &I, max_duration: C::Duration, ) -> Result<(), Error>

Register a task with the watchdog.

The task will be monitored by the watchdog.

Arguments:

  • id - The task identifier.
  • max_duration - The maximum duration between feeds. If there is a gap longer than this, the watchdog will trigger.
§Errors

If there are no available slots to register the task, an error will be returned.

Source

pub fn deregister_task(&mut self, id: &I)

Deregister a task from the watchdog.

The task will no longer be monitored by the watchdog.

Arguments:

  • id - The task identifier.
Source

pub fn feed(&mut self, id: &I)

Feed the watchdog for a specific task.

Source

pub fn start(&mut self)

Start the watchdog.

This starts the hardware watchdog. You must run the watchdog task now to monitor the tasks.

Source

pub fn check(&mut self) -> bool

Check if any tasks have starved the watchdog and take appropriate action.

Source

pub fn trigger_reset(&mut self) -> !

Trigger a system reset.

Source

pub fn reset_reason(&self) -> Option<ResetReason>

Get the reason for the last reset.

Auto Trait Implementations§

§

impl<I, const N: usize, W, C> Freeze for Watchdog<I, N, W, C>
where W: Freeze, C: Freeze, <C as Clock>::Duration: Freeze, I: Freeze, <C as Clock>::Instant: Freeze,

§

impl<I, const N: usize, W, C> RefUnwindSafe for Watchdog<I, N, W, C>

§

impl<I, const N: usize, W, C> Send for Watchdog<I, N, W, C>
where W: Send, C: Send, <C as Clock>::Duration: Send, I: Send, <C as Clock>::Instant: Send,

§

impl<I, const N: usize, W, C> Sync for Watchdog<I, N, W, C>
where W: Sync, C: Sync, <C as Clock>::Duration: Sync, I: Sync, <C as Clock>::Instant: Sync,

§

impl<I, const N: usize, W, C> Unpin for Watchdog<I, N, W, C>
where W: Unpin, C: Unpin, <C as Clock>::Duration: Unpin, I: Unpin, <C as Clock>::Instant: Unpin,

§

impl<I, const N: usize, W, C> UnwindSafe for Watchdog<I, N, W, C>

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<Choices> CoproductSubsetter<CNil, HNil> for Choices

Source§

type Remainder = Choices

Source§

fn subset( self, ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) 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> 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§

impl<T, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

Source§

fn lift_into(self) -> U

Performs the indexed conversion.
Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<Source> Sculptor<HNil, HNil> for Source

Source§

type Remainder = Source

Source§

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.