Struct FileWatcher

pub struct FileWatcher {
    pub path: PathBuf,
    /* private fields */
}

The FileWatcher struct defines the polling based state machine which reads from a file path, transparently updating the underlying file descriptor when the file has been rolled over, as is common for logs.

The FileWatcher is expected to live for the lifetime of the file path. FileServer is responsible for clearing away FileWatchers which no longer exist.

Fields

path: PathBuf

Implementations

impl FileWatcher

pub async fn new( path: PathBuf, read_from: ReadFrom, ignore_before: Option<DateTime<Utc>>, max_line_bytes: usize, line_delimiter: Bytes, ) -> Result<FileWatcher, Error>

Create a new FileWatcher

The input path will be used by FileWatcher to prime its state machine. A FileWatcher tracks only one file. This function returns None if the path does not exist or is not readable by the current process.

pub async fn update_path(&mut self, path: PathBuf) -> Result<()>

pub fn set_file_findable(&mut self, f: bool)

pub fn file_findable(&self) -> bool

pub fn set_dead(&mut self)

pub fn dead(&self) -> bool

pub fn get_file_position(&self) -> FilePosition

pub fn last_read_success(&self) -> Instant

pub fn should_read(&self) -> bool

pub fn last_seen(&self) -> Instant

pub fn reached_eof(&self) -> bool