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
impl RlgError
Sourcepub const fn code(&self) -> &'static str
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");Sourcepub const fn help(&self) -> Option<&'static str>
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());Sourcepub const fn report(&self) -> Report<'_>
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 Error for RlgError
impl Error for RlgError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
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
fn description(&self) -> &str
👎Deprecated since 1.42.0:
use the Display impl or to_string()
Source§impl From<ConfigError> for RlgError
impl From<ConfigError> for RlgError
Source§fn from(source: ConfigError) -> Self
fn from(source: ConfigError) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl !RefUnwindSafe for RlgError
impl !UnwindSafe for RlgError
impl Forget for RlgError
impl Freeze for RlgError
impl Send for RlgError
impl Sync for RlgError
impl Unpin for RlgError
impl UnsafeUnpin for RlgError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more