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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
use crate::flexi_error::FlexiLoggerError;
use crate::formats::default_format;
use crate::{Cleanup, Criterion, FileSpec, FormatFunction, Naming, WriteMode};
use std::path::{Path, PathBuf};
use std::sync::Arc;
use super::{FileLogWriter, FileLogWriterConfig, LogWriter, RotationConfig, State};
/// Builder for [`FileLogWriter`].
#[allow(clippy::struct_excessive_bools, clippy::module_name_repetitions)]
pub struct FileLogWriterBuilder {
cfg_print_message: bool,
cfg_append: bool,
cfg_write_mode: WriteMode,
file_spec: FileSpec,
cfg_o_create_symlink: Option<PathBuf>,
cfg_line_ending: &'static [u8],
format: FormatFunction,
o_rotation_config: Option<RotationConfig>,
max_log_level: log::LevelFilter,
cleanup_in_background_thread: bool,
use_utc: bool,
}
/// Methods for influencing the behavior of the [`FileLogWriter`].
impl FileLogWriterBuilder {
pub(crate) fn new(file_spec: FileSpec) -> Self {
Self {
o_rotation_config: None,
cfg_print_message: false,
file_spec,
cfg_append: false,
cfg_write_mode: WriteMode::Direct,
cfg_o_create_symlink: None,
cfg_line_ending: super::UNIX_LINE_ENDING,
format: default_format,
max_log_level: log::LevelFilter::Trace,
cleanup_in_background_thread: true,
use_utc: false,
}
}
/// Makes the [`FileLogWriter`] print an info message to stdout
/// when a new file is used for log-output.
#[must_use]
pub fn print_message(mut self) -> Self {
self.cfg_print_message = true;
self
}
/// Makes the [`FileLogWriter`] use the provided format function for the log entries,
/// rather than [`default_format`].
#[must_use]
pub fn format(mut self, format: FormatFunction) -> Self {
self.format = format;
self
}
/// Influences how the cleanup activities
/// (finding files, deleting files, optionally compressing files) are done
/// when rotation is used with some [`Cleanup`] variant.
///
/// With the synchronous [write modes](crate::WriteMode),
/// the cleanup activities are done by default in a dedicated background thread, to
/// minimize the blocking impact on your application.
/// You can avoid this extra thread by calling this method with
/// `use_background_thread = false`; the cleanup is then done synchronously
/// by the thread that is currently logging and - by chance - causing a file rotation.
///
/// With [`WriteMode::AsyncWith`](crate::WriteMode::AsyncWith),
/// the cleanup activities are always done by the same background thread
/// that also does the file I/O, this method then has no effect.
#[must_use]
pub fn cleanup_in_background_thread(mut self, use_background_thread: bool) -> Self {
self.cleanup_in_background_thread = use_background_thread;
self
}
/// Use rotation to prevent indefinite growth of log files.
///
/// By default, the log file is fixed while your program is running and will grow indefinitely.
/// With this option being used, when the log file reaches the specified criterion,
/// the file will be closed and a new file will be opened.
///
/// Note that also the filename pattern changes:
///
/// - by default, no timestamp is added to the filename
/// - the logs are always written to a file with infix `_rCURRENT`
/// - when the rotation criterion is fulfilled, it is closed and renamed to a file
/// with another infix (see `Naming`),
/// and then the logging continues again to the (fresh) file with infix `_rCURRENT`.
///
/// Example:
///
/// After some logging with your program `my_prog` and rotation with `Naming::Numbers`,
/// you will find files like
///
/// ```text
/// my_prog_r00000.log
/// my_prog_r00001.log
/// my_prog_r00002.log
/// my_prog_rCURRENT.log
/// ```
///
/// The cleanup parameter allows defining the strategy for dealing with older files.
/// See [`Cleanup`] for details.
#[must_use]
pub fn rotate(mut self, criterion: Criterion, naming: Naming, cleanup: Cleanup) -> Self {
self.o_rotation_config = Some(RotationConfig {
criterion,
naming,
cleanup,
});
self.file_spec.if_default_use_timestamp(false);
self
}
/// Set the file spec.
#[must_use]
pub(crate) fn file_spec(mut self, mut file_spec: FileSpec) -> Self {
if self.o_rotation_config.is_some() {
file_spec.if_default_use_timestamp(false);
}
self.file_spec = file_spec;
self
}
/// Makes the logger append to the given file, if it exists; by default, the file would be
/// truncated.
#[must_use]
pub fn append(mut self) -> Self {
self.cfg_append = true;
self
}
/// Set the maximum log level.
///
/// The default is `log::LevelFilter::Trace`, i.e., all log levels are written.
#[must_use]
pub fn max_level(mut self, max_log_level: log::LevelFilter) -> Self {
self.max_log_level = max_log_level;
self
}
/// Enforces the use of UTC, rather than local time.
#[must_use]
pub fn use_utc(mut self) -> Self {
self.file_spec.use_utc = true;
self.use_utc = true;
self
}
/// The specified String will be used on unix systems to create in the current folder
/// a symbolic link to the current log file.
#[must_use]
pub fn create_symlink<P: Into<PathBuf>>(mut self, symlink: P) -> Self {
self.cfg_o_create_symlink = Some(symlink.into());
self
}
/// Use Windows line endings, rather than just `\n`.
#[must_use]
pub fn use_windows_line_ending(mut self) -> Self {
self.cfg_line_ending = super::WINDOWS_LINE_ENDING;
self
}
/// Sets the write mode for the `FileLogWriter`.
///
/// See [`WriteMode`] for more (important!) details.
#[must_use]
pub fn write_mode(mut self, write_mode: WriteMode) -> Self {
self.cfg_write_mode = write_mode;
self
}
pub(crate) fn assert_write_mode(&self, write_mode: WriteMode) -> Result<(), FlexiLoggerError> {
if self.cfg_write_mode == write_mode {
Ok(())
} else {
Err(FlexiLoggerError::Reset)
}
}
#[must_use]
pub(crate) fn get_write_mode(&self) -> &WriteMode {
&self.cfg_write_mode
}
/// Produces the `FileLogWriter`.
///
/// # Errors
///
/// `FlexiLoggerError::Io` if the specified path doesn't work.
pub fn try_build(self) -> Result<FileLogWriter, FlexiLoggerError> {
Ok(FileLogWriter::new(
self.try_build_state()?,
self.max_log_level,
self.format,
))
}
/// Produces the `FileLogWriter` and a handle that is connected with it.
///
/// This allows handing out the `FileLogWriter` instance to methods that consume it, and still
/// be able to influence it via the handle.
///
/// # Errors
///
/// `FlexiLoggerError::Io` if the specified path doesn't work.
pub fn try_build_with_handle(
self,
) -> Result<(ArcFileLogWriter, FileLogWriterHandle), FlexiLoggerError> {
Ok(ArcFileLogWriter::new_with_handle(FileLogWriter::new(
self.try_build_state()?,
self.max_log_level,
self.format,
)))
}
pub(super) fn try_build_state(&self) -> Result<State, FlexiLoggerError> {
// make sure the folder exists or create it
let dir = self.file_spec.get_directory();
let p_directory = Path::new(&dir);
std::fs::create_dir_all(p_directory)?;
if !std::fs::metadata(p_directory)?.is_dir() {
return Err(FlexiLoggerError::OutputBadDirectory);
};
#[cfg(feature = "async")]
let cleanup_in_background_thread = if let WriteMode::AsyncWith {
pool_capa: _,
message_capa: _,
flush_interval: _,
} = self.cfg_write_mode
{
false
} else {
self.cleanup_in_background_thread
};
#[cfg(not(feature = "async"))]
let cleanup_in_background_thread = self.cleanup_in_background_thread;
Ok(State::new(
FileLogWriterConfig {
print_message: self.cfg_print_message,
append: self.cfg_append,
line_ending: self.cfg_line_ending,
write_mode: self.cfg_write_mode,
file_spec: self.file_spec.clone(),
o_create_symlink: self.cfg_o_create_symlink.clone(),
use_utc: self.use_utc,
},
self.o_rotation_config.clone(),
cleanup_in_background_thread,
))
}
}
/// Alternative set of methods to control the behavior of the `FileLogWriterBuilder`.
/// Use these methods when you want to control the settings flexibly,
/// e.g. with commandline arguments via `docopts` or `clap`.
impl FileLogWriterBuilder {
/// With true, makes the `FileLogWriterBuilder` print an info message to stdout, each time
/// when a new file is used for log-output.
#[must_use]
pub fn o_print_message(mut self, print_message: bool) -> Self {
self.cfg_print_message = print_message;
self
}
/// By default, and with None, the log file will grow indefinitely.
/// If a `rotate_config` is set, when the log file reaches or exceeds the specified size,
/// the file will be closed and a new file will be opened.
/// Also the filename pattern changes: instead of the timestamp, a serial number
/// is included into the filename.
///
/// The size is given in bytes, e.g. `o_rotate_over_size(Some(1_000))` will rotate
/// files once they reach a size of 1 kB.
///
/// The cleanup strategy allows delimiting the used space on disk.
#[must_use]
pub fn o_rotate(mut self, rotate_config: Option<(Criterion, Naming, Cleanup)>) -> Self {
if let Some((criterion, naming, cleanup)) = rotate_config {
self.o_rotation_config = Some(RotationConfig {
criterion,
naming,
cleanup,
});
self.file_spec.if_default_use_timestamp(false);
} else {
self.o_rotation_config = None;
self.file_spec.if_default_use_timestamp(true);
}
self
}
/// If append is set to true, makes the logger append to the given file, if it exists.
/// By default, or with false, the file would be truncated.
#[must_use]
pub fn o_append(mut self, append: bool) -> Self {
self.cfg_append = append;
self
}
/// If a String is specified, it will be used on unix systems to create in the current folder
/// a symbolic link with this name to the current log file.
#[must_use]
pub fn o_create_symlink<S: Into<PathBuf>>(mut self, symlink: Option<S>) -> Self {
self.cfg_o_create_symlink = symlink.map(Into::into);
self
}
}
/// A shareable `FileLogWriter` with a handle.
pub struct ArcFileLogWriter(Arc<FileLogWriter>);
impl ArcFileLogWriter {
pub(crate) fn new_with_handle(flw: FileLogWriter) -> (Self, FileLogWriterHandle) {
let a_flw = Arc::new(flw);
(Self(Arc::clone(&a_flw)), FileLogWriterHandle(a_flw))
}
}
impl Clone for ArcFileLogWriter {
fn clone(&self) -> Self {
Self(Arc::clone(&self.0))
}
}
impl std::io::Write for ArcFileLogWriter {
fn write(&mut self, buffer: &[u8]) -> std::result::Result<usize, std::io::Error> {
(*self.0).plain_write(buffer)
}
fn flush(&mut self) -> std::result::Result<(), std::io::Error> {
LogWriter::flush(&*self.0)
}
}
/// Handle to the `FileLogWriter` in an `ArcFileLogWriter`
/// that shuts down the `FileLogWriter` in its `Drop` implementation.
pub struct FileLogWriterHandle(Arc<FileLogWriter>);
impl Drop for FileLogWriterHandle {
fn drop(&mut self) {
self.0.shutdown();
}
}