Skip to main content

RlgError

Enum RlgError 

Source
pub enum RlgError {
    IoError(Error),
    ConfigError(ConfigError),
    FormatParseError(String),
    LevelParseError(String),
    UnsupportedFormat(String),
    FormattingError(String),
    RotationError(String),
    NetworkError(String),
    DateTimeParseError(String),
    Custom(String),
    NativeSinkError(String),
}
Expand description

Error variants for the RLG logging pipeline.

Variants§

§

IoError(Error)

I/O error

§

ConfigError(ConfigError)

Configuration error

§

FormatParseError(String)

Log format parse error

§

LevelParseError(String)

Log level parse error

§

UnsupportedFormat(String)

Unsupported log format

§

FormattingError(String)

Log formatting error

§

RotationError(String)

Log rotation error

§

NetworkError(String)

Network error

§

DateTimeParseError(String)

DateTime parse error

§

Custom(String)

Custom error

§

NativeSinkError(String)

Native OS sink failure

Implementations§

Source§

impl RlgError

Source

pub fn custom<T: Display>(msg: T) -> Self

Create a custom error with the given message.

Source

pub const fn code(&self) -> &'static str

A stable, machine-readable code for this error, such as rlg::io_error. Suitable for matching in tooling and for indexing error documentation.

§Examples
use rlg::error::RlgError;
let err = RlgError::RotationError("disk full".into());
assert_eq!(err.code(), "rlg::rotation_error");
Source

pub const fn help(&self) -> Option<&'static str>

A one-line hint on how to resolve this error, when there is one.

§Examples
use rlg::error::RlgError;
let err = RlgError::LevelParseError("LOUD".into());
assert!(err.help().unwrap().contains("TRACE"));
assert!(RlgError::custom("x").help().is_none());
Source

pub const fn report(&self) -> Report<'_>

Render the error as a multi-line report: the code, the message and, when there is one, the help line.

§Examples
use rlg::error::RlgError;
let err = RlgError::NetworkError("timeout".into());
assert_eq!(
    err.report().to_string(),
    "error[rlg::network_error]: Network error: timeout\n  \
     help: Check your network connection or the OTLP collector endpoint.",
);

Trait Implementations§

Source§

impl Debug for RlgError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RlgError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for RlgError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<CommonError> for RlgError

Source§

fn from(err: CommonError) -> Self

Converts to this type from the input type.
Source§

impl From<ConfigError> for RlgError

Source§

fn from(source: ConfigError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for RlgError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.