Struct staart::TailedFile

pub struct TailedFile<T> { /* private fields */ }

TailedFile tracks the state of a file being followed. It offers methods for updating this state, and printing data to stdout.

Implementations

impl<T> TailedFile<T>

where T: AsRef<Path> + Copy,

pub fn new(path: T) -> Result<TailedFile<T>, StaartError>

Creates an instance of std::io::Result<staart::TailedFile>

Example

let mut f = staart::TailedFile::new("/var/log/syslog");

Propagates Errors

• If the path provided does not exist, or is not readable by the current user
• If file metadata can not be read

pub fn read(&mut self) -> Result<Vec<u8>, StaartError>

Reads new data for an instance of staart::TailedFile and returns Result<Vec<u8>>

Prior to reading the file, it is checked for rotation and/or truncation.

pub fn read_and<F: Fn(&[u8])>(&mut self, f: F) -> Result<(), StaartError>

Passes &Vec<u8> read from the tailed file to a user-defined function returning the unit type ()`.