Struct string_err::StringError

pub struct StringError<E: ?Sized, B: MaybeBacktrace = ()> { /* fields omitted */ }

The string error type

See the crate documentation for examples on how to use this type.

Methods

impl StringError<(), ()>

pub fn new(msg: impl Into<String>) -> Self

Creates a new string error with no underlying error nor backtrace

This is not recommended to be used unless you really don't have an underlying error, and even so, it might be more useful to use StringError::with_backtrace, as at least you would have some reference.

impl StringError<(), Backtrace>

pub fn with_backtrace(msg: impl Into<String>) -> Self

Creates a new string error with no underlying error, but with a backtrace

This is reccomended only when you don't have an underlying error.

impl<E: Sized> StringError<E, ()>

pub fn with_err<R: Into<E>>(msg: impl Into<String>) -> impl FnOnce(R) -> Self

Returns a function to be passed to map_err, map_panic_err or alike that returns a string error with the underlying error but no backtrace

impl<E: Sized> StringError<E, Backtrace>

pub fn with_err_backtrace<R: Into<E>>(
    msg: impl Into<String>
) -> impl FnOnce(R) -> Self

Returns a function to be passed to map_err, map_panic_err or alike that returns a string error with the underlying error and a backtrace

impl<E: ?Sized, B: MaybeBacktrace> StringError<E, B>

#[must_use]pub fn msg(&self) -> &str

Returns the current message within this error

#[must_use]pub fn err(&self) -> &E

Returns the current underlying error within error

#[must_use]pub fn backtrace_maybe(&self) -> Option<&Backtrace>

Returns the backtrace, if any

impl<E: ?Sized> StringError<E, Backtrace>

#[must_use]pub const fn backtrace(&self) -> &Backtrace

Returns the existing backtrace

Trait Implementations

impl<E: ?Sized, B: MaybeBacktrace> Debug for StringError<E, B>

Default Debug impl for all StringError<E, B>

default fn fmt(&self, fmt: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<E: Sized + Debug, B: MaybeBacktrace> Debug for StringError<E, B>

Specialiation Debug impl for E: Sized + Debug

fn fmt(&self, fmt: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<E: Default + ?Sized, B: Default + MaybeBacktrace> Default for StringError<E, B>

fn default() -> StringError<E, B>

Returns the "default value" for a type.

impl<E: ?Sized, B: MaybeBacktrace> Display for StringError<E, B>

Display implementation for all StringError<E, B>

fn fmt(&self, fmt: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<E: Eq + ?Sized, B: Eq + MaybeBacktrace> Eq for StringError<E, B>

impl<E: ?Sized, B: MaybeBacktrace> Error for StringError<E, B>

Default Error impl for any all StringError<E, B>

default fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<E: Error + 'static, B: MaybeBacktrace> Error for StringError<E, B>

Specialization Error implementation for Error + 'static types Note: E can't be ?Sized because the pointer we'd return is a fat pointer with the size and the vtable, which itself is ?Sized

fn source(&self) -> Option<&(dyn Error + 'static)>

Note: Not default because if we do have a Error + 'static underlying error, we can always return it.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<E: Hash + ?Sized, B: Hash + MaybeBacktrace> Hash for StringError<E, B>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<E: PartialEq + ?Sized, B: PartialEq + MaybeBacktrace> PartialEq<StringError<E, B>> for StringError<E, B>

fn eq(&self, other: &StringError<E, B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StringError<E, B>) -> bool

This method tests for !=.

impl<E: ?Sized, B: MaybeBacktrace> StructuralEq for StringError<E, B>

impl<E: ?Sized, B: MaybeBacktrace> StructuralPartialEq for StringError<E, B>