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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
//! Write output to a file and rotate the files when limits have been exceeded.
//!
//! Defines a simple [std::io::Write] object that you can plug into your writers as middleware.
//!
//! # Content limit #
//!
//! [ContentLimit] specifies at what point a log file has to be rotated.
//!
//! ## Rotating by Lines ##
//!
//! We can rotate log files with the amount of lines as a limit, by using [ContentLimit::Lines].
//!
//! ```
//! use file_rotate::{FileRotate, ContentLimit, suffix::AppendCount, compression::Compression};
//! use std::{fs, io::Write};
//!
//! // Create a new log writer. The first argument is anything resembling a path. The
//! // basename is used for naming the log files.
//! //
//! // Here we choose to limit logs by 10 lines, and have at most 2 rotated log files. This
//! // makes the total amount of log files 3, since the original file is present as well.
//!
//! # let directory = tempfile::TempDir::new().unwrap();
//! # let directory = directory.path();
//! let log_path = directory.join("my-log-file");
//!
//! let mut log = FileRotate::new(
//! log_path.clone(),
//! AppendCount::new(2),
//! ContentLimit::Lines(3),
//! Compression::None,
//! #[cfg(unix)]
//! None,
//! );
//!
//! // Write a bunch of lines
//! writeln!(log, "Line 1: Hello World!");
//! for idx in 2..11 {
//! writeln!(log, "Line {}", idx);
//! }
//!
//! assert_eq!("Line 10\n", fs::read_to_string(&log_path).unwrap());
//!
//! assert_eq!("Line 4\nLine 5\nLine 6\n", fs::read_to_string(&directory.join("my-log-file.2")).unwrap());
//! assert_eq!("Line 7\nLine 8\nLine 9\n", fs::read_to_string(&directory.join("my-log-file.1")).unwrap());
//! ```
//!
//! ## Rotating by Bytes ##
//!
//! Another method of rotation is by bytes instead of lines, with [ContentLimit::Bytes].
//!
//! ```
//! use file_rotate::{FileRotate, ContentLimit, suffix::AppendCount, compression::Compression};
//! use std::{fs, io::Write};
//!
//! # let directory = tempfile::TempDir::new().unwrap();
//! # let directory = directory.path();
//! let log_path = directory.join("my-log-file");
//!
//! let mut log = FileRotate::new(
//! "target/my-log-directory-bytes/my-log-file",
//! AppendCount::new(2),
//! ContentLimit::Bytes(5),
//! Compression::None,
//! #[cfg(unix)]
//! None,
//! );
//!
//! writeln!(log, "Test file");
//!
//! assert_eq!("Test ", fs::read_to_string(&log.log_paths()[0]).unwrap());
//! assert_eq!("file\n", fs::read_to_string("target/my-log-directory-bytes/my-log-file").unwrap());
//!
//! fs::remove_dir_all("target/my-log-directory-bytes");
//! ```
//!
//! # Rotation Method #
//!
//! Two rotation methods are provided, but any behaviour can be implemented with the [SuffixScheme]
//! trait.
//!
//! ## Basic count ##
//!
//! With [AppendCount], when the limit is reached in the main log file, the file is moved with
//! suffix `.1`, and subsequently numbered files are moved in a cascade.
//!
//! Here's an example with 1 byte limits:
//!
//! ```
//! use file_rotate::{FileRotate, ContentLimit, suffix::AppendCount, compression::Compression};
//! use std::{fs, io::Write};
//!
//! # let directory = tempfile::TempDir::new().unwrap();
//! # let directory = directory.path();
//! let log_path = directory.join("my-log-file");
//!
//! let mut log = FileRotate::new(
//! log_path.clone(),
//! AppendCount::new(3),
//! ContentLimit::Bytes(1),
//! Compression::None,
//! #[cfg(unix)]
//! None,
//! );
//!
//! write!(log, "A");
//! assert_eq!("A", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "B");
//! assert_eq!("A", fs::read_to_string(directory.join("my-log-file.1")).unwrap());
//! assert_eq!("B", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "C");
//! assert_eq!("A", fs::read_to_string(directory.join("my-log-file.2")).unwrap());
//! assert_eq!("B", fs::read_to_string(directory.join("my-log-file.1")).unwrap());
//! assert_eq!("C", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "D");
//! assert_eq!("A", fs::read_to_string(directory.join("my-log-file.3")).unwrap());
//! assert_eq!("B", fs::read_to_string(directory.join("my-log-file.2")).unwrap());
//! assert_eq!("C", fs::read_to_string(directory.join("my-log-file.1")).unwrap());
//! assert_eq!("D", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "E");
//! assert_eq!("B", fs::read_to_string(directory.join("my-log-file.3")).unwrap());
//! assert_eq!("C", fs::read_to_string(directory.join("my-log-file.2")).unwrap());
//! assert_eq!("D", fs::read_to_string(directory.join("my-log-file.1")).unwrap());
//! assert_eq!("E", fs::read_to_string(&log_path).unwrap());
//! ```
//!
//! ## Timestamp suffix ##
//!
//! With [AppendTimestamp], when the limit is reached in the main log file, the file is moved with
//! suffix equal to the current timestamp (with the specified or a default format). If the
//! destination file name already exists, `.1` (and up) is appended.
//!
//! Note that this works somewhat different to `AppendCount` because of lexical ordering concerns:
//! Higher numbers mean more recent logs, whereas `AppendCount` works in the opposite way.
//! The reason for this is to keep the lexical ordering of log names consistent: Higher lexical value
//! means more recent.
//! This is of course all assuming that the format start with the year (or most significant
//! component).
//!
//! With this suffix scheme, you can also decide whether to delete old files based on the age of
//! their timestamp ([FileLimit::Age]), or just maximum number of files ([FileLimit::MaxFiles]).
//!
//! ```
//! use file_rotate::{FileRotate, ContentLimit, suffix::{AppendTimestamp, FileLimit},
//! compression::Compression};
//! use std::{fs, io::Write};
//!
//! # let directory = tempfile::TempDir::new().unwrap();
//! # let directory = directory.path();
//! let log_path = directory.join("my-log-file");
//!
//! let mut log = FileRotate::new(
//! log_path.clone(),
//! AppendTimestamp::default(FileLimit::MaxFiles(2)),
//! ContentLimit::Bytes(1),
//! Compression::None,
//! #[cfg(unix)]
//! None,
//! );
//!
//! write!(log, "A");
//! assert_eq!("A", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "B");
//! assert_eq!("A", fs::read_to_string(&log.log_paths()[0]).unwrap());
//! assert_eq!("B", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "C");
//! assert_eq!("A", fs::read_to_string(&log.log_paths()[0]).unwrap());
//! assert_eq!("B", fs::read_to_string(&log.log_paths()[1]).unwrap());
//! assert_eq!("C", fs::read_to_string(&log_path).unwrap());
//!
//! write!(log, "D");
//! assert_eq!("B", fs::read_to_string(&log.log_paths()[0]).unwrap());
//! assert_eq!("C", fs::read_to_string(&log.log_paths()[1]).unwrap());
//! assert_eq!("D", fs::read_to_string(&log_path).unwrap());
//! ```
//!
//! If you use timestamps as suffix, you can also configure files to be removed as they reach a
//! certain age. For example:
//! ```rust
//! use file_rotate::suffix::{AppendTimestamp, FileLimit};
//! AppendTimestamp::default(FileLimit::Age(chrono::Duration::weeks(1)));
//! ```
//!
//! # Compression #
//!
//! Select a [Compression] mode to make the file rotater compress old files using flate2.
//! Compressed files get an additional suffix `.gz` after the main suffix.
//!
//! ## Compression example ##
//! If we run this:
//!
//! ```ignore
//! use file_rotate::{compression::*, suffix::*, *};
//! use std::io::Write;
//!
//! let mut log = FileRotate::new(
//! "./log",
//! AppendTimestamp::default(FileLimit::MaxFiles(4)),
//! ContentLimit::Bytes(1),
//! Compression::OnRotate(2),
//! #[cfg(unix)]
//! None,
//! );
//!
//! for i in 0..6 {
//! write!(log, "{}", i).unwrap();
//! std::thread::sleep(std::time::Duration::from_secs(1));
//! }
//! ```
//! The following files will be created:
//! ```ignore
//! log log.20220112T112415.gz log.20220112T112416.gz log.20220112T112417 log.20220112T112418
//! ```
//! And we can assemble all the available log data with:
//! ```ignore
//! $ gunzip -c log.20220112T112415.gz ; gunzip -c log.20220112T112416.gz ; cat log.20220112T112417 log.20220112T112418 log
//! 12345
//! ```
//!
//!
//! ## Get structured list of log files ##
//!
//! We can programmatically get the list of log files.
//! The following code scans the current directory and recognizes log files based on their file name:
//!
//! ```
//! # use file_rotate::{suffix::*, *};
//! # use std::path::Path;
//! println!(
//! "{:#?}",
//! AppendTimestamp::default(FileLimit::MaxFiles(4)).scan_suffixes(Path::new("./log"))
//! );
//! ```
//!
//! [SuffixScheme::scan_suffixes] also takes into account the possibility of the extra `.gz` suffix, and
//! interprets it correctly as compression. The output:
//!
//! ```ignore
//! {
//! SuffixInfo {
//! suffix: TimestampSuffix {
//! timestamp: "20220112T112418",
//! number: None,
//! },
//! compressed: false,
//! },
//! SuffixInfo {
//! suffix: TimestampSuffix {
//! timestamp: "20220112T112417",
//! number: None,
//! },
//! compressed: false,
//! },
//! SuffixInfo {
//! suffix: TimestampSuffix {
//! timestamp: "20220112T112416",
//! number: None,
//! },
//! compressed: true,
//! },
//! SuffixInfo {
//! suffix: TimestampSuffix {
//! timestamp: "20220112T112415",
//! number: None,
//! },
//! compressed: true,
//! },
//! }
//! ```
//! This information can be used by for example a program to assemble log history.
//!
//! # Filesystem Errors #
//!
//! If the directory containing the logs is deleted or somehow made inaccessible then the rotator
//! will simply continue operating without fault. When a rotation occurs, it attempts to open a
//! file in the directory. If it can, it will just continue logging. If it can't then the written
//! data is sent to the void.
#![deny(
missing_docs,
trivial_casts,
trivial_numeric_casts,
unsafe_code,
unused_import_braces,
unused_qualifications
)]
use chrono::prelude::*;
use compression::*;
use std::io::{BufRead, BufReader};
use std::{
cmp::Ordering,
collections::BTreeSet,
fs::{self, File, OpenOptions},
io::{self, Write},
path::{Path, PathBuf},
};
use suffix::*;
#[cfg(unix)]
use std::os::unix::fs::OpenOptionsExt;
pub mod compression;
pub mod suffix;
#[cfg(test)]
mod tests;
// ---
/// At which frequency to rotate the file.
#[derive(Clone, Copy, Debug)]
pub enum TimeFrequency {
/// Rotate every hour.
Hourly,
/// Rotate one time a day.
Daily,
/// Rotate ones a week.
Weekly,
/// Rotate every month.
Monthly,
/// Rotate yearly.
Yearly,
}
/// When to move files: Condition on which a file is rotated.
#[derive(Clone, Debug)]
pub enum ContentLimit {
/// Cut the log at the exact size in bytes.
Bytes(usize),
/// Cut the log file at line breaks.
Lines(usize),
/// Cut the log at time interval.
Time(TimeFrequency),
/// Cut the log file after surpassing size in bytes (but having written a complete buffer from a write call.)
BytesSurpassed(usize),
/// Don't do any rotation automatically
None,
}
/// Used mostly internally. Info about suffix + compressed state.
#[derive(Clone, Debug, Eq)]
pub struct SuffixInfo<Repr> {
/// Suffix
pub suffix: Repr,
/// Whether there is a `.gz` suffix after the suffix
pub compressed: bool,
}
impl<R: PartialEq> PartialEq for SuffixInfo<R> {
fn eq(&self, other: &Self) -> bool {
self.suffix == other.suffix
}
}
impl<Repr: Representation> SuffixInfo<Repr> {
/// Append this suffix (and eventual `.gz`) to a path
pub fn to_path(&self, basepath: &Path) -> PathBuf {
let path = self.suffix.to_path(basepath);
if self.compressed {
PathBuf::from(format!("{}.gz", path.display()))
} else {
path
}
}
}
impl<Repr: Representation> Ord for SuffixInfo<Repr> {
fn cmp(&self, other: &Self) -> Ordering {
self.suffix.cmp(&other.suffix)
}
}
impl<Repr: Representation> PartialOrd for SuffixInfo<Repr> {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
/// The main writer used for rotating logs.
#[derive(Debug)]
pub struct FileRotate<S: SuffixScheme> {
basepath: PathBuf,
file: Option<File>,
modified: Option<DateTime<Local>>,
content_limit: ContentLimit,
count: usize,
compression: Compression,
suffix_scheme: S,
/// The bool is whether or not there's a .gz suffix to the filename
suffixes: BTreeSet<SuffixInfo<S::Repr>>,
#[cfg(unix)]
mode: Option<u32>,
}
impl<S: SuffixScheme> FileRotate<S> {
/// Create a new [FileRotate].
///
/// The basename of the `path` is used to create new log files by appending an extension of the
/// form `.N`, where N is `0..=max_files`.
///
/// `content_limit` specifies the limits for rotating a file.
///
/// # Panics
///
/// Panics if `bytes == 0` or `lines == 0`.
pub fn new<P: AsRef<Path>>(
path: P,
suffix_scheme: S,
content_limit: ContentLimit,
compression: Compression,
#[cfg(unix)] mode: Option<u32>,
) -> Self {
match content_limit {
ContentLimit::Bytes(bytes) => {
assert!(bytes > 0);
}
ContentLimit::Lines(lines) => {
assert!(lines > 0);
}
ContentLimit::Time(_) => {}
ContentLimit::BytesSurpassed(bytes) => {
assert!(bytes > 0);
}
ContentLimit::None => {}
};
let basepath = path.as_ref().to_path_buf();
fs::create_dir_all(basepath.parent().unwrap()).expect("create dir");
let mut s = Self {
file: None,
modified: None,
basepath,
content_limit,
count: 0,
compression,
suffixes: BTreeSet::new(),
suffix_scheme,
#[cfg(unix)]
mode,
};
s.ensure_log_directory_exists();
s.scan_suffixes();
s
}
fn ensure_log_directory_exists(&mut self) {
let path = self.basepath.parent().unwrap();
if !path.exists() {
let _ = fs::create_dir_all(path).expect("create dir");
self.scan_suffixes();
}
if !self.basepath.exists() || self.file.is_none() {
// Open or create the file
self.open_file();
match self.file {
None => self.count = 0,
Some(ref mut file) => {
match self.content_limit {
ContentLimit::Bytes(_) | ContentLimit::BytesSurpassed(_) => {
// Update byte `count`
if let Ok(metadata) = file.metadata() {
self.count = metadata.len() as usize;
} else {
self.count = 0;
}
}
ContentLimit::Lines(_) => {
self.count = BufReader::new(file).lines().count();
}
ContentLimit::Time(_) => {
self.modified = mtime(file);
}
ContentLimit::None => {}
}
}
}
}
}
fn open_file(&mut self) {
let mut open_options = OpenOptions::new();
open_options.read(true).create(true).append(true);
#[cfg(unix)]
if let Some(mode) = self.mode {
open_options.mode(mode);
}
self.file = open_options.open(&self.basepath).ok();
}
fn scan_suffixes(&mut self) {
self.suffixes = self.suffix_scheme.scan_suffixes(&self.basepath);
}
/// Get paths of rotated log files (excluding the original/current log file), ordered from
/// oldest to most recent
pub fn log_paths(&mut self) -> Vec<PathBuf> {
self.suffixes
.iter()
.rev()
.map(|suffix| suffix.to_path(&self.basepath))
.collect::<Vec<_>>()
}
/// Recursive function that keeps moving files if there's any file name collision.
/// If `suffix` is `None`, it moves from basepath to next suffix given by the SuffixScheme
/// Assumption: Any collision in file name is due to an old log file.
///
/// Returns the suffix of the new file (the last suffix after possible cascade of renames).
fn move_file_with_suffix(
&mut self,
old_suffix_info: Option<SuffixInfo<S::Repr>>,
) -> io::Result<SuffixInfo<S::Repr>> {
// NOTE: this newest_suffix is there only because AppendTimestamp specifically needs
// it. Otherwise it might not be necessary to provide this to `rotate_file`. We could also
// have passed the internal BTreeMap itself, but it would require to make SuffixInfo `pub`.
let newest_suffix = self.suffixes.iter().next().map(|info| &info.suffix);
let new_suffix = self.suffix_scheme.rotate_file(
&self.basepath,
newest_suffix,
&old_suffix_info.clone().map(|i| i.suffix),
)?;
// The destination file/path eventual .gz suffix must match the source path
let new_suffix_info = SuffixInfo {
suffix: new_suffix,
compressed: old_suffix_info
.as_ref()
.map(|x| x.compressed)
.unwrap_or(false),
};
let new_path = new_suffix_info.to_path(&self.basepath);
// Whatever exists that would block a move to the new suffix
let existing_suffix_info = self.suffixes.get(&new_suffix_info).cloned();
// Move destination file out of the way if it exists
let newly_created_suffix = if let Some(existing_suffix_info) = existing_suffix_info {
// We might move files in a way that the destination path doesn't equal the path that
// was replaced. Due to possible `.gz`, a "conflicting" file doesn't mean that paths
// are equal.
self.suffixes.replace(new_suffix_info);
// Recurse to move conflicting file.
self.move_file_with_suffix(Some(existing_suffix_info))?
} else {
new_suffix_info
};
let old_path = match old_suffix_info {
Some(suffix) => suffix.to_path(&self.basepath),
None => self.basepath.clone(),
};
// Do the move
assert!(old_path.exists());
assert!(!new_path.exists());
fs::rename(old_path, new_path)?;
Ok(newly_created_suffix)
}
/// Trigger a log rotation manually. This is mostly intended for use with `ContentLimit::None`
/// but will work with all content limits.
pub fn rotate(&mut self) -> io::Result<()> {
self.ensure_log_directory_exists();
let _ = self.file.take();
// This function will always create a new file. Returns suffix of that file
let new_suffix_info = self.move_file_with_suffix(None)?;
self.suffixes.insert(new_suffix_info);
self.open_file();
self.count = 0;
self.handle_old_files()?;
Ok(())
}
fn handle_old_files(&mut self) -> io::Result<()> {
// Find the youngest suffix that is too old, and then remove all suffixes that are older or
// equally old:
let mut youngest_old = None;
// Start from oldest suffix, stop when we find a suffix that is not too old
let mut result = Ok(());
for (i, suffix) in self.suffixes.iter().enumerate().rev() {
if self.suffix_scheme.too_old(&suffix.suffix, i) {
result = result.and(fs::remove_file(suffix.to_path(&self.basepath)));
youngest_old = Some((*suffix).clone());
} else {
break;
}
}
if let Some(youngest_old) = youngest_old {
// Removes all the too old
let _ = self.suffixes.split_off(&youngest_old);
}
// Compression
if let Compression::OnRotate(max_file_n) = self.compression {
let n = (self.suffixes.len() as i32 - max_file_n as i32).max(0) as usize;
// The oldest N files should be compressed
let suffixes_to_compress = self
.suffixes
.iter()
.rev()
.take(n)
.filter(|info| !info.compressed)
.cloned()
.collect::<Vec<_>>();
for info in suffixes_to_compress {
// Do the compression
let path = info.suffix.to_path(&self.basepath);
compress(&path)?;
self.suffixes.replace(SuffixInfo {
compressed: true,
..info
});
}
}
result
}
}
impl<S: SuffixScheme> Write for FileRotate<S> {
fn write(&mut self, mut buf: &[u8]) -> io::Result<usize> {
let written = buf.len();
match self.content_limit {
ContentLimit::Bytes(bytes) => {
while self.count + buf.len() > bytes {
let bytes_left = bytes.saturating_sub(self.count);
if let Some(ref mut file) = self.file {
file.write_all(&buf[..bytes_left])?;
}
self.rotate()?;
buf = &buf[bytes_left..];
}
self.count += buf.len();
if let Some(ref mut file) = self.file {
file.write_all(buf)?;
}
}
ContentLimit::Time(time) => {
let local: DateTime<Local> = now();
if let Some(modified) = self.modified {
match time {
TimeFrequency::Hourly => {
if local.hour() != modified.hour()
|| local.day() != modified.day()
|| local.month() != modified.month()
|| local.year() != modified.year()
{
self.rotate()?;
}
}
TimeFrequency::Daily => {
if local.date() > modified.date() {
self.rotate()?;
}
}
TimeFrequency::Weekly => {
if local.iso_week().week() != modified.iso_week().week()
|| local.year() > modified.year()
{
self.rotate()?;
}
}
TimeFrequency::Monthly => {
if local.month() != modified.month() || local.year() != modified.year()
{
self.rotate()?;
}
}
TimeFrequency::Yearly => {
if local.year() > modified.year() {
self.rotate()?;
}
}
}
}
if let Some(ref mut file) = self.file {
file.write_all(buf)?;
self.modified = Some(local);
}
}
ContentLimit::Lines(lines) => {
while let Some((idx, _)) = buf.iter().enumerate().find(|(_, byte)| *byte == &b'\n')
{
if let Some(ref mut file) = self.file {
file.write_all(&buf[..idx + 1])?;
}
self.count += 1;
buf = &buf[idx + 1..];
if self.count >= lines {
self.rotate()?;
}
}
if let Some(ref mut file) = self.file {
file.write_all(buf)?;
}
}
ContentLimit::BytesSurpassed(bytes) => {
if self.count > bytes {
self.rotate()?
}
if let Some(ref mut file) = self.file {
file.write_all(buf)?;
}
self.count += buf.len();
}
ContentLimit::None => {
if let Some(ref mut file) = self.file {
file.write_all(buf)?;
}
}
}
Ok(written)
}
fn flush(&mut self) -> io::Result<()> {
self.file
.as_mut()
.map(|file| file.flush())
.unwrap_or(Ok(()))
}
}
/// Get modification time, in non test case.
#[cfg(not(test))]
fn mtime(file: &File) -> Option<DateTime<Local>> {
if let Ok(time) = file.metadata().and_then(|metadata| metadata.modified()) {
return Some(time.into());
}
None
}
/// Get modification time, in test case.
#[cfg(test)]
fn mtime(_: &File) -> Option<DateTime<Local>> {
Some(now())
}
/// Get system time, in non test case.
#[cfg(not(test))]
fn now() -> DateTime<Local> {
Local::now()
}
/// Get mocked system time, in test case.
#[cfg(test)]
pub mod mock_time {
use super::*;
use std::cell::RefCell;
thread_local! {
static MOCK_TIME: RefCell<Option<DateTime<Local>>> = RefCell::new(None);
}
pub fn now() -> DateTime<Local> {
MOCK_TIME.with(|cell| cell.borrow().as_ref().cloned().unwrap_or_else(Local::now))
}
pub fn set_mock_time(time: DateTime<Local>) {
MOCK_TIME.with(|cell| *cell.borrow_mut() = Some(time));
}
}
#[cfg(test)]
pub use mock_time::now;