Struct FileStream

Source

pub struct FileStream { /* private fields */ }

Expand description

Used to output logs to a file.

§Examples

Writing a log to a file:

// Required by `FileStream` for parsing logs
let mut formatter = LogFormatter::default();

let mut file_output = FileStream::default();

// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// Enable the output
file_output.enable()
    .expect("Failed to enable the output!");

// Write to the log file buffer
file_output.out(&LogStruct::debug("Hello from file!"), &mut formatter)
    .expect("Failed to write to the buffer!");

// Flush the logs from the buffer to the log file
file_output.flush();

Implementations§

Source §

impl FileStream

Source

pub fn set_log_file_path(&mut self, path: &str) -> Result<(), Error>

Sets the log file path.

§Examples


// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// And then enable the output
file_output.enable()
    .expect("Failed to enable the output!");

Source

pub fn out( &mut self, log: &LogStruct, formatter: &mut LogFormatter, ) -> Result<(), Error>

Formats the given log using a formatter and stores it in a buffer until it is flushed.

§Examples


// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// And then enable the output
file_output.enable()
    .expect("Failed to enable the output!");

// Write to the buffer 100 times
for i in 0..100 {
    file_output.out(&LogStruct::debug(&format!("Log number {}", i)),
        &mut formatter).expect("Failed to write to the buffer!");
}

// Write the log buffer contents to the log file
file_output.flush();

Source

pub fn flush(&mut self) -> Result<(), Error>

Flush the contents of the log buffer to the log file.

§Examples


// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// And then enable the output
file_output.enable()
    .expect("Failed to enable the output!");

file_output.out(&LogStruct::debug(&format!("Hello from file!")),
    &mut formatter).expect("Failed to write to the buffer!");

// Write the log buffer contents to the log file
file_output.flush();

Source

pub fn set_max_buffer_size<I: Into<Option<usize>>>(&mut self, size: I)

Sets the maximum size of the log buffer.

When the buffer exceeds this size, its contents are written to a file and then cleared.

§Examples

// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// And then enable the output
file_output.enable()
    .expect("Failed to enable the output!");

// Define the maximum buffer size
let max_size = 128;
file_output.set_max_buffer_size(Some(max_size));
for i in 0..max_size {
    // Write to the buffer
    file_output.out(&LogStruct::debug(&format!("Log number {}", i)),
        &mut formatter).expect("Failed to write to the buffer!");
}
// Here the buffer will be flushed to the log file.

Source

pub fn enable(&mut self) -> Result<(), Error>

Enables the output.

Returns an error if the log file is not writable.

§Examples


// Set the log file path **first**
file_output.set_log_file_path(&path)
    .expect("Failed to set the log file path!");

// And then enable the output
file_output.enable()
    .expect("Failed to enable the output!");

Source