Struct LoopGuard

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

Utility for preventing infinite loops

Use as a guard rail inside a loop block

Implementations§

Source§

impl LoopGuard

Source

pub fn new(max: i32) -> LoopGuard

§Create a new LoopGuard

Make sure to create the LoopGuard instance outside the loop block

§Arguments
  • max_ticks - The limit of how many times a loop should run
use loop_guard::LoopGuard;

let mut guard = LoopGuard::new(10);

loop {
    guard.protect() // This will panic after 10 loops
}
Source

pub fn set_panic_message(self, message: &str) -> Self

Set a custom panic message for a LoopGuard instance

Source

pub fn protect(&mut self)

From within a while or loop block, panic if the loop iteration surpasses the LoopGuard’s max_ticks value.

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, 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.