Enum ErrorKind

pub enum ErrorKind {
    ContextLock,
    ContextInconsistent,
    ScopeNotInitialized,
    KeyNotInitialized,
    ParseEnv,
    ParseArg,
    EnvType,
    UnknownLogLevel,
    WriteFailed,
    InvalFmtString,
    LogCompatInitialized,
    TaskLocal(TaskLocalErr),
    IoError(ErrorKind),
}

A list of possible errors that can occur in this library

This list is intended to be grow over time and is not recommended to be exhaustively matched.

It is used with the Result type to signal that an error occurred.

The IoError variant is used to catch any underlying std::io::Errors without mapping them to internal error(s). This allows a better control over underling errors instead of “hiding” them.

Handling errors and matching ErrorKind

In application code match against the expected ErrorKind, use _ to match all other Errors.

use hclog::{ErrorKind};

match hclog::dump(&mut std::io::stdout()) {
   Ok(_) => {},
   Err(ErrorKind::IoError(e)) => eprintln!("I/O Error: {:?}", e),
   Err(_) => panic!("Unexpected error"),
}

Variants

ContextLock

Failed to lock the context

ContextInconsistent

Context is inconsistent

ScopeNotInitialized

Log-Module isn’t initialized

KeyNotInitialized

Submodule is not initialized

ParseEnv

Parse environment variable failed

ParseArg

Parse commandline argument string failed

EnvType

Environment variable has unexpected type

UnknownLogLevel

Loglevel is unknown

WriteFailed

Failed to write logstring via Facade

InvalFmtString

Logging string contained non utf8 characters

LogCompatInitialized

Log Compat is already initialized

TaskLocal(TaskLocalErr)

Error in task local access

IoError(ErrorKind)

I/O Error while writing

Wraps the std::io::ErrorKind thrown by the underlying I/O operation.

Trait Implementations

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl Error for ErrorKind

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for ErrorKind

fn from(io: IoError) -> Self

Converts to this type from the input type.

impl From<NulError> for ErrorKind

fn from(_: NulError) -> Self

Converts to this type from the input type.

impl<T: 'static> From<PoisonError<T>> for ErrorKind

fn from(_: PoisonError<T>) -> Self

Converts to this type from the input type.

impl From<SetLoggerError> for ErrorKind

fn from(_: SetLoggerError) -> Self

Converts to this type from the input type.

impl Ord for ErrorKind

fn cmp(&self, other: &ErrorKind) -> 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 PartialEq for ErrorKind

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

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

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

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

impl PartialOrd for ErrorKind

fn partial_cmp(&self, other: &ErrorKind) -> 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 Eq for ErrorKind

impl StructuralPartialEq for ErrorKind