Skip to main content

FileListener

Struct FileListener 

Source
pub struct FileListener { /* private fields */ }
Expand description

A listener that monitors a file for changes and captures new lines.

Use tick() to poll for changes.

Implementations§

Source§

impl FileListener

Source

pub fn builder<P: AsRef<Path>>(path: P) -> FileListenerBuilder

Creates a new FileListenerBuilder for the given file path.

Source

pub fn tick(&mut self) -> Result<()>

Checks the file for changes and updates the internal line buffer.

This method handles:

  • Connecting to the file if it appears.
  • Backfilling lines on the first connection.
  • Detecting truncation or modification and resetting if necessary.
  • Appending new lines as they are written.
§Errors

Returns an [Error] if filesystem operations fail (other than NotFound, which is handled gracefully).

Source

pub const fn lines(&self) -> &VecDeque<(DateTime<Utc>, String)>

Returns an immutable reference to the internal buffer of lines.

Source

pub fn len(&self) -> usize

Returns the number of buffered lines.

Source

pub fn is_empty(&self) -> bool

Returns true if there are no buffered lines.

Source

pub fn clear(&mut self)

Clears all buffered lines.

Source

pub fn drain(&mut self) -> Drain<'_, (DateTime<Utc>, String)>

Drains and yields all buffered lines.

Source

pub fn path(&self) -> &Path

Returns the watched path.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.