Struct File

Source

pub struct File { /* private fields */ }

Expand description

File output target.

This target writes log messages to a file on disk. ANSI color codes are automatically stripped from messages written to files.

Implementations§

Source §

impl File

Source

pub fn new(path: P, mode: FileMode) -> Result<Self, Error>
where P: AsRef<Path>,

Creates a new file target.

This function will create the parent directories if they don’t exist and open the file in append mode.

§Arguments

path - Path to the log file’
mode - File open mode (default: Append)

§Returns

A new File target instance or an error if the file couldn’t be opened

§Examples

use logger::{Config, File, init_with_config};

let file_target = File::new("logs/app.log").expect("Failed to open log file");
let config = Config {
    targets: vec![Box::new(file_target)],
    ..Config::default()
};
init_with_config(config);

Examples found in repository ?

examples/level-filtering.rs (line 9)

3fn main() {
4    traccia::init_with_config(traccia::Config {
5        level: LogLevel::Trace,
6        targets: vec![
7            Box::new(traccia::Console::new()),
8            Box::new(
9                traccia::File::new("./.logs/latest.log", FileMode::Truncate)
10                    .expect("Failed to open file.")
11                    .filtered(LogLevel::Fatal),
12            ),
13        ],
14        ..Default::default()
15    });
16
17    info!("This will not be written to latest.log, but will be printed to console.");
18    error!("It will write fatal messages only!");
19    fatal!("Like this :(");
20}

More examples

Hide additional examples

examples/target.rs (line 9)

3fn main() {
4    traccia::init_with_config(traccia::Config {
5        level: LogLevel::Trace,
6        targets: vec![
7            Box::new(traccia::Console::new()),
8            Box::new(
9                traccia::File::new(".logs/latest.log", FileMode::Truncate)
10                    .unwrap()
11                    .filtered(LogLevel::Fatal),
12            ),
13        ],
14        ..Default::default()
15    });
16
17    trace!("This is a trace message");
18    debug!("This is a debug message");
19    info!("This is an info message");
20    warn!("This is a warn message");
21    error!("This is an error message");
22    fatal!("This is a fatal message");
23}

examples/hooks.rs (line 29)

3fn main() {
4    traccia::set_hook(Hook::AfterLog(Box::new(|_, target| {
5        if let TargetId::Console(_) = target {
6            println!("This will be printed after the log message");
7        }
8    })));
9
10    traccia::set_hook(Hook::BeforeLog(Box::new(|level, target| {
11        if let TargetId::File(_) = target {
12            if level == LogLevel::Info {
13                println!("This will be printed only before calling the info! macro on a file.")
14            }
15        }
16    })));
17
18    traccia::set_hook(Hook::BeforeLog(Box::new(|_, target| {
19        if let TargetId::Console(_) = target {
20            println!("This will be printed before the log message");
21        }
22    })));
23
24    traccia::init_with_config(traccia::Config {
25        level: LogLevel::Trace,
26        targets: vec![
27            Box::new(traccia::Console::new()),
28            Box::new(
29                traccia::File::new("./.logs/latest.log", traccia::FileMode::Truncate)
30                    .expect("Failed to open file."),
31            ),
32        ],
33        ..Default::default()
34    });
35
36    info!("This is a test log message");
37    warn!("This is a test warning message");
38}

Source

pub fn filtered(self, level: LogLevel) -> Self

Sets a custom filter level for the file target. If the filter level is set, log messages with a lower level will be ignored.

Useful for filtering log messages written to files.

Examples found in repository ?

examples/level-filtering.rs (line 11)

3fn main() {
4    traccia::init_with_config(traccia::Config {
5        level: LogLevel::Trace,
6        targets: vec![
7            Box::new(traccia::Console::new()),
8            Box::new(
9                traccia::File::new("./.logs/latest.log", FileMode::Truncate)
10                    .expect("Failed to open file.")
11                    .filtered(LogLevel::Fatal),
12            ),
13        ],
14        ..Default::default()
15    });
16
17    info!("This will not be written to latest.log, but will be printed to console.");
18    error!("It will write fatal messages only!");
19    fatal!("Like this :(");
20}

More examples

Hide additional examples

examples/target.rs (line 11)

3fn main() {
4    traccia::init_with_config(traccia::Config {
5        level: LogLevel::Trace,
6        targets: vec![
7            Box::new(traccia::Console::new()),
8            Box::new(
9                traccia::File::new(".logs/latest.log", FileMode::Truncate)
10                    .unwrap()
11                    .filtered(LogLevel::Fatal),
12            ),
13        ],
14        ..Default::default()
15    });
16
17    trace!("This is a trace message");
18    debug!("This is a debug message");
19    info!("This is an info message");
20    warn!("This is a warn message");
21    error!("This is an error message");
22    fatal!("This is a fatal message");
23}

Methods from Deref<Target = Mutex<File>>§

Source

pub fn get_cloned(&self) -> Result<T, PoisonError<()>>
where T: Clone,

🔬This is a nightly-only experimental API. (lock_value_accessors)

Returns the contained value by cloning it.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error instead.

§Examples

#![feature(lock_value_accessors)]

use std::sync::Mutex;

let mut mutex = Mutex::new(7);

assert_eq!(mutex.get_cloned().unwrap(), 7);

Source

pub fn set(&self, value: T) -> Result<(), PoisonError<T>>

🔬This is a nightly-only experimental API. (lock_value_accessors)

Sets the contained value.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error containing the provided value instead.

§Examples

#![feature(lock_value_accessors)]

use std::sync::Mutex;

let mut mutex = Mutex::new(7);

assert_eq!(mutex.get_cloned().unwrap(), 7);
mutex.set(11).unwrap();
assert_eq!(mutex.get_cloned().unwrap(), 11);

Source

pub fn replace(&self, value: T) -> Result<T, PoisonError<T>>

🔬This is a nightly-only experimental API. (lock_value_accessors)

Replaces the contained value with value, and returns the old contained value.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error containing the provided value instead.

§Examples

#![feature(lock_value_accessors)]

use std::sync::Mutex;

let mut mutex = Mutex::new(7);

assert_eq!(mutex.replace(11).unwrap(), 7);
assert_eq!(mutex.get_cloned().unwrap(), 11);

1.0.0 · Source

pub fn lock(&self) -> Result<MutexGuard<'_, T>, PoisonError<MutexGuard<'_, T>>>

Acquires a mutex, blocking the current thread until it is able to do so.

This function will block the local thread until it is available to acquire the mutex. Upon returning, the thread is the only thread with the lock held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.

The exact behavior on locking a mutex in the thread which already holds the lock is left unspecified. However, this function will not return on the second call (it might panic or deadlock, for example).

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error once the mutex is acquired. The acquired mutex guard will be contained in the returned error.

§Panics

This function might panic when called if the lock is already held by the current thread.

§Examples

use std::sync::{Arc, Mutex};
use std::thread;

let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);

thread::spawn(move || {
    *c_mutex.lock().unwrap() = 10;
}).join().expect("thread::spawn failed");
assert_eq!(*mutex.lock().unwrap(), 10);

1.0.0 · Source

pub fn try_lock( &self, ) -> Result<MutexGuard<'_, T>, TryLockError<MutexGuard<'_, T>>>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then Err is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

This function does not block.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return the Poisoned error if the mutex would otherwise be acquired. An acquired lock guard will be contained in the returned error.

If the mutex could not be acquired because it is already locked, then this call will return the WouldBlock error.

§Examples

use std::sync::{Arc, Mutex};
use std::thread;

let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);

thread::spawn(move || {
    let mut lock = c_mutex.try_lock();
    if let Ok(ref mut mutex) = lock {
        **mutex = 10;
    } else {
        println!("try_lock failed");
    }
}).join().expect("thread::spawn failed");
assert_eq!(*mutex.lock().unwrap(), 10);

1.2.0 · Source

pub fn is_poisoned(&self) -> bool

Determines whether the mutex is poisoned.

If another thread is active, the mutex can still become poisoned at any time. You should not trust a false value for program correctness without additional synchronization.

§Examples

use std::sync::{Arc, Mutex};
use std::thread;

let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);

let _ = thread::spawn(move || {
    let _lock = c_mutex.lock().unwrap();
    panic!(); // the mutex gets poisoned
}).join();
assert_eq!(mutex.is_poisoned(), true);

1.77.0 · Source

pub fn clear_poison(&self)

Clear the poisoned state from a mutex.

If the mutex is poisoned, it will remain poisoned until this function is called. This allows recovering from a poisoned state and marking that it has recovered. For example, if the value is overwritten by a known-good value, then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to determine if it is in a consistent state, and if so the poison is removed.

§Examples

use std::sync::{Arc, Mutex};
use std::thread;

let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);

let _ = thread::spawn(move || {
    let _lock = c_mutex.lock().unwrap();
    panic!(); // the mutex gets poisoned
}).join();

assert_eq!(mutex.is_poisoned(), true);
let x = mutex.lock().unwrap_or_else(|mut e| {
    **e.get_mut() = 1;
    mutex.clear_poison();
    e.into_inner()
});
assert_eq!(mutex.is_poisoned(), false);
assert_eq!(*x, 1);

Source

pub fn data_ptr(&self) -> *mut T

🔬This is a nightly-only experimental API. (mutex_data_ptr)

Returns a raw pointer to the underlying data.

The returned pointer is always non-null and properly aligned, but it is the user’s responsibility to ensure that any reads and writes through it are properly synchronized to avoid data races, and that it is not read or written through after the mutex is dropped.