1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
//! Provides error types.
use std::{
fmt::{self, Display},
io, result,
};
use atomic::Atomic;
use static_assertions::const_assert;
use thiserror::Error;
pub use crate::env_level::EnvLevelError;
#[cfg(feature = "multi-thread")]
use crate::{sink::Task, RecordOwned};
/// The error type of this crate.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum Error {
/// The variant returned by [`Formatter`]s when an error occurs in
/// formatting a record.
///
/// [`Formatter`]: crate::formatter::Formatter
#[error("format record error: {0}")]
FormatRecord(fmt::Error),
/// The variant returned by [`Sink`]s when an error occurs in writing a
/// record to the target.
///
/// [`Sink`]: crate::sink::Sink
#[error("write record error: {0}")]
WriteRecord(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in flushing the
/// buffer.
///
/// [`Sink`]: crate::sink::Sink
#[error("flush buffer error: {0}")]
FlushBuffer(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in creating a
/// directory.
///
/// [`Sink`]: crate::sink::Sink
#[error("create directory error: {0}")]
CreateDirectory(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in opening a
/// file.
///
/// [`Sink`]: crate::sink::Sink
#[error("open file error: {0}")]
OpenFile(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in querying the
/// metadata of a file.
///
/// [`Sink`]: crate::sink::Sink
#[error("query file metadata error: {0}")]
QueryFileMetadata(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in renaming a
/// file.
///
/// [`Sink`]: crate::sink::Sink
#[error("rename file error: {0}")]
RenameFile(io::Error),
/// The variant returned by [`Sink`]s when an error occurs in removing a
/// file.
///
/// [`Sink`]: crate::sink::Sink
#[error("remove file error: {0}")]
RemoveFile(io::Error),
/// The variant returned by [`from_str`] when the string doesn't match any
/// of the log levels.
///
/// [`from_str`]: std::str::FromStr::from_str
#[error("attempted to convert a string that doesn't match an existing log level: {0}")]
ParseLevel(String),
/// The variant returned if an invalid argument was passed in.
#[error("invalid argument {0}")]
InvalidArgument(#[from] InvalidArgumentError),
/// The variant returned by [`Sink`]s when an error occurs in sending to the
/// channel.
///
/// [`Sink`]: crate::sink::Sink
#[cfg(feature = "multi-thread")]
#[error("failed to send message to channel: {0}")]
SendToChannel(SendToChannelError, SendToChannelErrorDropped),
}
/// This error type contains a variety of possible invalid arguments.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum InvalidArgumentError {
/// Invalid logger name.
///
/// See the documentation of [`LoggerBuilder::name`] for the name
/// requirements.
///
/// [`LoggerBuilder::name`]: crate::LoggerBuilder::name
#[error("'logger name': {0}")]
LoggerName(#[from] SetLoggerNameError),
/// Invalid [`RotationPolicy`].
///
/// See the documentation of [`RotationPolicy`] for the input requirements.
///
/// [`RotationPolicy`]: crate::sink::RotationPolicy
#[error("'rotation policy': {0}")]
RotationPolicy(String),
/// Invalid thread pool capacity.
#[error("'thread pool capacity': {0}")]
ThreadPoolCapacity(String),
}
/// This error indicates that an invalid logger name was set.
///
/// See the documentation of [`LoggerBuilder::name`] for the name requirements.
///
/// [`LoggerBuilder::name`]: crate::LoggerBuilder::name
#[derive(Error, Debug)]
pub struct SetLoggerNameError {
name: String,
}
impl SetLoggerNameError {
#[must_use]
pub(crate) fn new(name: impl Into<String>) -> Self {
Self { name: name.into() }
}
#[cfg(test)]
#[must_use]
pub(crate) fn name(&self) -> &str {
&self.name
}
}
impl Display for SetLoggerNameError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "name '{}' contains disallowed characters", self.name)
}
}
/// The more detailed error type of sending to channel.
#[cfg(feature = "multi-thread")]
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum SendToChannelError {
/// The channel is full.
///
/// The variant returned only when [`OverflowPolicy::DropIncoming`] is used.
///
/// [`OverflowPolicy::DropIncoming`]: crate::sink::async_sink::OverflowPolicy::DropIncoming
#[error("the channel is full")]
Full,
/// The channel is disconnected.
#[error("the channel is disconnected")]
Disconnected,
}
/// Contains data that is dropped after sending to the channel failed.
///
/// You can handle them manually or just ignore them.
#[cfg(feature = "multi-thread")]
#[derive(Debug)]
#[non_exhaustive]
pub enum SendToChannelErrorDropped {
/// A `log` operation and a record are dropped.
// TODO: Box the `RecordOwned` in the next minor version, as it's a bit large.
Record(RecordOwned),
/// A `flush` operation is dropped.
Flush,
}
#[cfg(feature = "multi-thread")]
impl Error {
#[must_use]
pub(crate) fn from_crossbeam_send(err: crossbeam::channel::SendError<Task>) -> Self {
Self::SendToChannel(
SendToChannelError::Disconnected,
SendToChannelErrorDropped::from_task(err.0),
)
}
#[must_use]
pub(crate) fn from_crossbeam_try_send(err: crossbeam::channel::TrySendError<Task>) -> Self {
use crossbeam::channel::TrySendError;
let (error, dropped_task) = match err {
TrySendError::Full(dropped) => (SendToChannelError::Full, dropped),
TrySendError::Disconnected(dropped) => (SendToChannelError::Disconnected, dropped),
};
Self::SendToChannel(error, SendToChannelErrorDropped::from_task(dropped_task))
}
}
#[cfg(feature = "multi-thread")]
impl SendToChannelErrorDropped {
#[must_use]
pub(crate) fn from_task(task: Task) -> Self {
match task {
Task::Log { record, .. } => Self::Record(record),
Task::Flush { .. } => Self::Flush,
}
}
}
/// The result type of this crate.
pub type Result<T> = result::Result<T, Error>;
/// The error handler function type.
pub type ErrorHandler = fn(Error);
const_assert!(Atomic::<ErrorHandler>::is_lock_free());
const_assert!(Atomic::<Option<ErrorHandler>>::is_lock_free());