Struct staart::TailedFile

pub struct TailedFile<'a> { /* fields omitted */ }

TailedFile tracks the state of a file being followed. It offers methods for updating this state, and printing data to stdout. The user may define the duration between updates if operating in a loop with delay.

Implementations

impl<'a> TailedFile<'a>

pub fn new(path: &str) -> Result<TailedFile<'_>>

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

Example

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

Defaults

• delay: 100ms

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 update_status(&mut self) -> Result<()>

Updates the status of an instance of staart::TailedFile

File metadata are refreshed, and the position is updated if changes have occured since the last read operation.

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

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

pub fn follow(&mut self) -> Result<(), Box<dyn Error>>

Prints new data read on an instance of staart::TailedFile to stdout

pub fn set_delay(&mut self, d: u64)

Sets a delay duration, in milliseconds, for an instance of staart::TailedFile. This value is used when calling staart::TailedFile::sleep().

pub fn sleep(&mut self)

Sleeps for staart::TailedFile.delay milliseconds