Struct Follow 

pub struct Follow { /* private fields */ }

A file being followed: its watcher, and what the view has taken of it. Belongs to the dataset; dropping it stops the watcher.

Implementations

impl Follow

pub fn start( tail: Tail, interval: Duration, events: Sender<AppEvent>, spool: Option<Arc<SpoolHandle>>, ) -> Follow

Follow the file tail counted, whose first tail.rows() rows the frame reads, checking every interval and telling events. spool is standard input being copied to it.

pub fn as_pipe(self) -> Follow

This follows standard input read as it arrives rather than --follow: the view starts at the top and stays where it is put.

pub fn is_pipe(&self) -> bool

Whether this is standard input read as it arrives (Self::as_pipe).

pub fn live(&self) -> bool

Whether more rows may still come: followed and not ended.

pub fn id(&self) -> u64

pub fn path(&self) -> &Path

pub fn shown(&self) -> usize

Rows the frame reads.

pub fn waiting(&self) -> usize

Rows counted that the view has not taken yet.

pub fn misfits(&self) -> usize

pub fn standing(&self) -> &Standing

pub fn new_below(&self) -> usize

Rows that arrived below the cursor while it was off the last row.

pub fn behind(&self) -> bool

Whether the view has rows or a restart to take: not while paused. The rows counted before standard input ended are taken after it did.

pub fn spool(&self) -> Option<&Arc<Spool>>

Standard input being copied, if this follows it.

pub fn check_now(&self)

Look now rather than at the end of the interval.

pub fn take(&mut self, change: &Change) -> Option<String>

Take a report from this follow’s watcher. Returns what the user is told, if anything.

pub fn catch_up(&mut self) -> (usize, bool)

The view takes what was counted: the rows its frame reads from now on, and whether the file was read again from its start.

pub fn take_held(&mut self) -> Option<Arc<File>>

The handle a deleted file is read through, once, for the frames to take.

pub fn pause(&mut self)

pub fn resume(&mut self)

pub fn end(&mut self)

Stop watching. What the frame reads stays. Standard input stops being read, unless it is being recorded (--tee): that is stopped only when asked.

Trait Implementations

impl Drop for Follow

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.