Struct error_log::ErrorLog

pub struct ErrorLog<T, E> { /* private fields */ }

A Object to store multiple error messages and display them at once

Operations

x:ErrorLog, E:Error, T:ok value, U:any type

• *x: ok()/ok_mut(): get (mutable) ok value as Option
• x += Result<U, E>: Shorthand for push_result()
• x += E: Shorthand for push_err()
• x *= Result <T, E>: Shorthand for merge_result()

Implementations

impl<T, E> ErrorLog<T, E>

pub fn clear_delimiter(&mut self) -> &mut Self

Reset delimiter to default value.

pub fn delimiter(&mut self, delimiter: impl Into<String>)

Set delimiter. Takes any value that can be converted to String.

pub fn display_mode(&mut self, mode: FormatMode) -> &mut Self

Set how the errors should be formatted:

• Normal: {} (Default)
• Debug: {:?}
• PrettyDebug: {:#?}

pub fn get_format_mode(&self) -> &FormatMode

Get FormatMode

pub fn get_instant_display(&self) -> bool

Get weightier the function display incoming entries instantly. Note: Entries wont get stored when true

pub fn instant_display(&mut self, val: bool) -> &mut Self

Set weightier the function display incoming entries instantly. Note: Entries wont get stored when true

pub fn join_on_display(&mut self, join: bool) -> &mut Self

Set weightier to join Entries into one big String when displaying them.

impl<T, E: Display + Debug> ErrorLog<T, E>

pub fn join_to_string(&self) -> Option<String>

Get String of Combined Entries

pub fn display_mut(&mut self) -> Option<&mut T>

Displays Entries and returns Option to mutable reference of ok value

pub fn display_ok(self) -> Option<T>

Displays Entries and returns ok value as Option

pub fn display_ref(&self) -> Option<&T>

Displays Entries and returns Option to reference of ok value

pub fn display_take(&mut self) -> Option<T>

Display Entries and take ok value from Option

pub fn display_take_unwrap(&mut self) -> T

Display Entries and get ok value, panicking if no value set.

Related: display_ok()

pub fn display_unwrap(self) -> T

Displays Entries and get ok value, panicking if no value set.

Related: display_ok()

pub fn display_unwrap_or(self, or: T) -> T

Display entries and get ok value, using given value if no value set

Its recommended to use display_unwrap_or_else() when the alternative value needs to be calculated

pub fn display_unwrap_or_default(self) -> Twhere T: Default,

Display entries and get ok value, using default value if no value set

pub fn display_unwrap_or_else(self, run: impl FnOnce() -> T) -> T

Display entries and get ok value, using value calculated from given closure

Related: display_unwrap_or()

impl<T, E> ErrorLog<T, E>

pub fn entries(&self) -> &Entries<E>

Get immutable reference to Vector of Entries NOTE: Does not filter entries

pub fn entries_mut(&mut self) -> &mut Entries<E>

Get mutable reference to Vector of Entries NOTE: Does not filter entries lower than maximum LevelFilter

pub fn entries_owned(&mut self) -> Entries<E>

Get owned Entries, Removing them from Instance

pub fn messages_clone(&self) -> Entries<E>

Get cloned vector of messages. Filters out errors.

pub fn messages_owned(self) -> Entries<E>

Get owned log messages as Entries, firing out all

impl<T, E: Clone> ErrorLog<T, E>

pub fn entries_cloned(&self) -> Entries<E>

Clone Entries. Filters messages lower than the max_level

pub fn errors_cloned(&self) -> Vec<E>

Get cloned errors as vector. Filters out all Messages lower than the max_level.

impl<T, E: Debug + Display> ErrorLog<T, E>

pub fn append_entries<U>(&mut self, other: &mut ErrorLog<U, E>) -> &mut Self

Appends errors from another instance

pub fn clear_entries(&mut self) -> &mut Self

Removes all entries from Self.

pub fn map_error_log<U: Debug, F: Display>( self, fun: impl FnOnce(Self) -> ErrorLog<U, F> ) -> ErrorLog<U, F>

Maps instance to change error and ok type

pub fn prepend_entries<U>(&mut self, other: &mut ErrorLog<U, E>) -> &mut Self

Appends Entries before the Entries of the current Vec

impl<T, E: Debug + Display> ErrorLog<T, E>

pub fn merge_result<U: Into<T>, F: Into<E>>( &mut self, res: Result<U, F> ) -> bool

Stores Ok value from Result or push Err from Result to entries

pub fn push_err(&mut self, err: impl Into<E>) -> &mut Self

Push error to entries

pub fn push_result<U, F: Into<E>>(&mut self, res: Result<U, F>) -> Option<U>

Push error of result to entries. Returns Ok value of give result as Option

impl<T, E> ErrorLog<T, E>

pub fn new() -> Self

Create a new Instance

pub fn ok(&self) -> &Option<T>

Get immutable reference to ok value

pub fn ok_discard(self) -> Option<T>

Get owned ok value, discarding all entries. Related: display_ok()

pub fn ok_mut(&mut self) -> &mut Option<T>

Get mutable reference to ok value

pub fn ok_take(&mut self) -> Option<T>

Take ok value

pub fn display_fn(&self) -> fn(_: LevelFilter, _: i64, _: String)

Get display function

pub fn set_ok(&mut self, new: impl Into<T>) -> &mut Self

Set ok value. Takes any value that can be converted to String

pub fn clear_ok(&mut self) -> &mut Self

Removes ok value

pub fn set_display_fn( &mut self, fun: fn(_: LevelFilter, _: i64, _: String) ) -> &mut Self

Set print function

impl<T> ErrorLog<T, Box<dyn DebugDisplay>>

pub fn merge_result_box<U: Into<T>, F: DebugDisplay + 'static>( &mut self, res: Result<U, F> ) -> bool

If the Result is an Ok variant, store ok value. If the Result is an Err variant, store the Error as Box

pub fn push_err_box(&mut self, err: impl DebugDisplay + 'static) -> &mut Self

Puts error in a Box and stores it

pub fn push_result_box<U: Into<T>, F: DebugDisplay + 'static>( &mut self, res: Result<U, F> ) -> Option<U>

If the Result contains an error, put error in a Box and store it. Returns Ok value of given Result as Option

impl<T, E> ErrorLog<T, E>

pub fn max_level(&mut self, level: LevelFilter) -> &mut Self

Sets max LevelFilter of displayed messages Note: when LevelFilter::Off, all messages get ignored, but errors still show

pub fn max_level_debug( &mut self, release: LevelFilter, debug: LevelFilter ) -> &mut Self

Sets different max LevelFilter of displayed messages depending on if this is an debug build or a release one.

pub fn get_max_level(&self) -> &LevelFilter

Gets max LevelFilter. Any Message of Lower Priority will be ignored

pub fn push_message( &mut self, level: LevelFilter, msg: impl Into<String> ) -> &mut Self

Pushes Message to entries. Its recommended to use the built in macros instead:

• log_error
• log_warn
• log_info
• log_debug
• log_trace

impl<T, E> ErrorLog<T, E>

pub fn display_fn_log(&mut self) -> &mut Self

Display entries using log macros

pub fn display_fn_println(&mut self) -> &mut Self

Display errors using println

Methods from Deref<Target = Option<T>>

pub fn is_some(&self) -> bool

Returns true if the option is a Some value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);

pub fn is_none(&self) -> bool

Returns true if the option is a None value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);

pub fn as_ref(&self) -> Option<&T>

Converts from &Option<T> to Option<&T>.

Examples

Calculates the length of an Option<String> as an Option<usize> without moving the String. The map method takes the self argument by value, consuming the original, so this technique uses as_ref to first take an Option to a reference to the value inside the original.

let text: Option<String> = Some("Hello, world!".to_string());
// First, cast `Option<String>` to `Option<&String>` with `as_ref`,
// then consume *that* with `map`, leaving `text` on the stack.
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");

pub fn as_mut(&mut self) -> Option<&mut T>

Converts from &mut Option<T> to Option<&mut T>.

Examples

let mut x = Some(2);
match x.as_mut() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

pub fn as_pin_ref(self: Pin<&Option<T>>) -> Option<Pin<&T>>

Converts from Pin<&Option<T>> to Option<Pin<&T>>.

pub fn as_pin_mut(self: Pin<&mut Option<T>>) -> Option<Pin<&mut T>>

Converts from Pin<&mut Option<T>> to Option<Pin<&mut T>>.

pub fn as_slice(&self) -> &[T]

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

Returns a slice of the contained value, if any. If this is None, an empty slice is returned. This can be useful to have a single type of iterator over an Option or slice.

Note: Should you have an Option<&T> and wish to get a slice of T, you can unpack it via opt.map_or(&[], std::slice::from_ref).

Examples

#![feature(option_as_slice)]

assert_eq!(
    [Some(1234).as_slice(), None.as_slice()],
    [&[1234][..], &[][..]],
);

The inverse of this function is (discounting borrowing) [_]::first:

#![feature(option_as_slice)]

for i in [Some(1234_u16), None] {
    assert_eq!(i.as_ref(), i.as_slice().first());
}

pub fn as_mut_slice(&mut self) -> &mut [T]

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

Returns a mutable slice of the contained value, if any. If this is None, an empty slice is returned. This can be useful to have a single type of iterator over an Option or slice.

Note: Should you have an Option<&mut T> instead of a &mut Option<T>, which this method takes, you can obtain a mutable slice via opt.map_or(&mut [], std::slice::from_mut).

Examples

#![feature(option_as_slice)]

assert_eq!(
    [Some(1234).as_mut_slice(), None.as_mut_slice()],
    [&mut [1234][..], &mut [][..]],
);

The result is a mutable slice of zero or one items that points into our original Option:

#![feature(option_as_slice)]

let mut x = Some(1234);
x.as_mut_slice()[0] += 1;
assert_eq!(x, Some(1235));

The inverse of this method (discounting borrowing) is [_]::first_mut:

#![feature(option_as_slice)]

assert_eq!(Some(123).as_mut_slice().first_mut(), Some(&mut 123))

pub fn as_deref(&self) -> Option<&<T as Deref>::Target>where T: Deref,

Converts from Option<T> (or &Option<T>) to Option<&T::Target>.

Leaves the original Option in-place, creating a new one with a reference to the original one, additionally coercing the contents via Deref.

Examples

let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);

pub fn as_deref_mut(&mut self) -> Option<&mut <T as Deref>::Target>where T: DerefMut,

Converts from Option<T> (or &mut Option<T>) to Option<&mut T::Target>.

Leaves the original Option in-place, creating a new one containing a mutable reference to the inner type’s Deref::Target type.

Examples

let mut x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref_mut().map(|x| {
    x.make_ascii_uppercase();
    x
}), Some("HEY".to_owned().as_mut_str()));

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

Examples

let x = Some(4);
assert_eq!(x.iter().next(), Some(&4));

let x: Option<u32> = None;
assert_eq!(x.iter().next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

Examples

let mut x = Some(4);
match x.iter_mut().next() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

let mut x: Option<u32> = None;
assert_eq!(x.iter_mut().next(), None);

pub fn insert(&mut self, value: T) -> &mut T

Inserts value into the option, then returns a mutable reference to it.

If the option already contains a value, the old value is dropped.

See also Option::get_or_insert, which doesn’t update the value if the option already contains Some.

Example

let mut opt = None;
let val = opt.insert(1);
assert_eq!(*val, 1);
assert_eq!(opt.unwrap(), 1);
let val = opt.insert(2);
assert_eq!(*val, 2);
*val = 3;
assert_eq!(opt.unwrap(), 3);

pub fn get_or_insert(&mut self, value: T) -> &mut T

Inserts value into the option if it is None, then returns a mutable reference to the contained value.

See also Option::insert, which updates the value even if the option already contains Some.

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert(5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_default(&mut self) -> &mut Twhere T: Default,

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

Inserts the default value into the option if it is None, then returns a mutable reference to the contained value.

Examples

#![feature(option_get_or_insert_default)]

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_default();
    assert_eq!(y, &0);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut Twhere F: FnOnce() -> T,

Inserts a value computed from f into the option if it is None, then returns a mutable reference to the contained value.

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_with(|| 5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn take(&mut self) -> Option<T>

Takes the value out of the option, leaving a None in its place.

Examples

let mut x = Some(2);
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, Some(2));

let mut x: Option<u32> = None;
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, None);

pub fn replace(&mut self, value: T) -> Option<T>

Replaces the actual value in the option by the value given in parameter, returning the old value if present, leaving a Some in its place without deinitializing either one.

Examples

let mut x = Some(2);
let old = x.replace(5);
assert_eq!(x, Some(5));
assert_eq!(old, Some(2));

let mut x = None;
let old = x.replace(3);
assert_eq!(x, Some(3));
assert_eq!(old, None);

Trait Implementations

impl<T, E: Debug + Display> AddAssign<E> for ErrorLog<T, E>

fn add_assign(&mut self, rhs: E)

Make err_log += ERROR store error if Result if an Err.

Shorthand for push_err()

impl<T, U, E: Debug + Display> AddAssign<Result<U, E>> for ErrorLog<T, E>

fn add_assign(&mut self, rhs: Result<U, E>)

Make err_log += RESULT store error of Result if any.

Shorthand for push_result()

impl<T: Clone, E: Clone> Clone for ErrorLog<T, E>

fn clone(&self) -> ErrorLog<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for ErrorLog<T, E>

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

Formats the value using the given formatter.

impl<T, E> Default for ErrorLog<T, E>

fn default() -> Self

Returns the “default value” for a type.

impl<T, E> Deref for ErrorLog<T, E>

Get immutable ‘ok’ value as Option by dereferencing

type Target = Option<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, E> DerefMut for ErrorLog<T, E>

Get mutable ‘ok’ value as Option by dereferencing

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

Mutably dereferences the value.

impl<T, E> IntoIterator for ErrorLog<T, E>

fn into_iter(self) -> Self::IntoIter

Iterates over Error stored.

type Item = Entry<E>

The type of the elements being iterated over.

type IntoIter = IntoIter<<ErrorLog<T, E> as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

impl<T, U: Into<T>, E> MulAssign<Option<U>> for ErrorLog<T, E>

fn mul_assign(&mut self, rhs: Option<U>)

Performs the *= operation.

impl<T, U: Into<T>, E: Debug + Display, F: Into<E>> MulAssign<Result<U, F>> for ErrorLog<T, E>

fn mul_assign(&mut self, rhs: Result<U, F>)

Performs the *= operation.

impl<T: Ord, E: Ord> Ord for ErrorLog<T, E>

fn cmp(&self, other: &ErrorLog<T, E>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq, E: PartialEq> PartialEq<ErrorLog<T, E>> for ErrorLog<T, E>

fn eq(&self, other: &ErrorLog<T, E>) -> bool

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

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

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

impl<T: PartialOrd, E: PartialOrd> PartialOrd<ErrorLog<T, E>> for ErrorLog<T, E>

fn partial_cmp(&self, other: &ErrorLog<T, E>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, E> Termination for ErrorLog<T, E>

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.

impl<T: Eq, E: Eq> Eq for ErrorLog<T, E>

impl<T, E> StructuralEq for ErrorLog<T, E>

impl<T, E> StructuralPartialEq for ErrorLog<T, E>