Struct PanicMsg

pub struct PanicMsg<M: Display = &'static str> { /* private fields */ }

A message for runtime panics. When one of the methods is called on it, the given message is used as the output for the panic.

Example

const EXAMPLE_PANIC: PanicMsg = PanicMsg::new("This is an example panic message.");
// ...
EXAMPLE_PANIC.panic();
// ...
EXAMPLE_PANIC.panic_if(left >= right);
// ...
EXAMPLE_PANIC.assert(left < right);
// ...
EXAMPLE_PANIC.assert_eq(left, right);
// ...
EXAMPLE_PANIC.assert_ne(left, right);
// ...
EXAMPLE_PANIC.expect(option);
// ...
EXAMPLE_PANIC.expect(result);
// ...
EXAMPLE_PANIC.debug_panic();
// ...
EXAMPLE_PANIC.debug_panic_if(left >= right);
// ...
EXAMPLE_PANIC.debug_assert(left < right);
// ...
EXAMPLE_PANIC.debug_assert_eq(left, right);
// ...
EXAMPLE_PANIC.debug_assert_ne(left, right);

Implementations

impl<M: Display> PanicMsg<M>

pub const fn new(message: M) -> Self

Create a new PanicMsg.

pub fn panic(&self) -> !

Panic at runtime.

See panic.

pub fn panic_if(&self, condition: bool)

Panic if the condition is true at runtime.

See panic.

pub fn assert(&self, condition: bool)

Asserts that a boolean expression is true at runtime.

see assert.

pub fn assert_eq<L, R>(&self, lhs: L, rhs: R)

where L: PartialEq<R> + Debug, R: Debug,

Assert that two expressions are equal to each other (using PartialEq).

See assert_eq.

pub fn assert_ne<L, R>(&self, lhs: L, rhs: R)

where L: PartialEq<R> + Debug, R: Debug,

Assert that two expressions are not equal to each other (using PartialEq).

See assert_ne.

pub fn debug_panic(&self)

Panic at runtime with debug_assertions.

See panic.

pub fn debug_panic_if(&self, condition: bool)

Panic if the condition is true at runtime with debug_assertions.

See panic.

pub fn debug_assert(&self, condition: bool)

Asserts that a boolean expression is true at runtime with debug_assertions.

see assert.

pub fn debug_assert_eq<L, R>(&self, lhs: L, rhs: R)

where L: PartialEq<R> + Debug, R: Debug,

Assert that two expressions are equal to each other (using PartialEq) with debug_assertions.

See assert_eq.

pub fn debug_assert_ne<L, R>(&self, lhs: L, rhs: R)

where L: PartialEq<R> + Debug, R: Debug,

Assert that two expressions are not equal to each other (using PartialEq) with debug_assertions.

See assert_ne.

pub fn expect<T: IntoOption>(&self, value: T) -> T::OptionT

pub const fn msg(&self) -> &M

Resturn a reference to the contained message.

Trait Implementations

impl<M: Display> AsMut<M> for PanicMsg<M>

fn as_mut(&mut self) -> &mut M

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M: Display> AsMut<PanicMsg<M>> for PanicMsg<M>

fn as_mut(&mut self) -> &mut PanicMsg<M>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M: Display> AsRef<M> for PanicMsg<M>

fn as_ref(&self) -> &M

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: Display> AsRef<PanicMsg<M>> for PanicMsg<M>

fn as_ref(&self) -> &PanicMsg<M>

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: Display> Borrow<M> for PanicMsg<M>

fn borrow(&self) -> &M

Immutably borrows from an owned value.

impl<M: Display> BorrowMut<M> for PanicMsg<M>

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

Mutably borrows from an owned value.

impl<M: Display + Clone> Clone for PanicMsg<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug + Display> Debug for PanicMsg<M>

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

Formats the value using the given formatter.

impl<M: Display> Deref for PanicMsg<M>

type Target = M

The resulting type after dereferencing.

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

Dereferences the value.

impl<M: Display> DerefMut for PanicMsg<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<M: Display> Display for PanicMsg<M>

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

Formats the value using the given formatter.

impl<M: Display + Hash> Hash for PanicMsg<M>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)

where Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<M: Display + Ord> Ord for PanicMsg<M>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<M: Display + PartialEq> PartialEq<M> for PanicMsg<M>

fn eq(&self, other: &M) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &M) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M: Display + PartialEq> PartialEq for PanicMsg<M>

fn eq(&self, other: &PanicMsg<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PanicMsg<M>) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M: Display + PartialOrd> PartialOrd<M> for PanicMsg<M>

fn partial_cmp(&self, other: &M) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<M: Display + PartialOrd> PartialOrd for PanicMsg<M>

fn partial_cmp(&self, other: &PanicMsg<M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<M: Display + Copy> Copy for PanicMsg<M>

impl<M: Display + Eq> Eq for PanicMsg<M>