Skip to main content

IncrementalCounts

Struct IncrementalCounts 

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

A running tally of the gh records logged since a fixed instant, refreshed by reading only what was appended since the previous refresh.

Equivalent to aggregate over [since, ∞), minus the cost: construction reads no records, and each refresh reads only the complete lines appended after the last one. A line still being written (no trailing newline yet) is left for the next refresh, so a record is counted once, whole. That is the one way the two differ over the same bytes: aggregate counts a final line with no newline if it happens to parse, this waits for the newline.

Implementations§

Source§

impl IncrementalCounts

Source

pub fn start(path: PathBuf) -> Self

Starts tallying the log at path from now: records already in it are never read, and the tally begins at zero.

The log’s extent is taken before the clock is read. A record stamped at or after since was therefore appended after the baseline, so the bytes the next refresh reads contain every record the window admits. Reading them in the other order could skip a record stamped just after the clock read but appended before the baseline.

Source

pub fn since(&self) -> DateTime<Utc>

The instant the window opened: records stamped before it are not counted.

Source

pub fn counts(&self) -> &GhCounts

The tally as of the last refresh.

Source

pub fn refresh(&mut self, stop: impl FnMut() -> bool) -> bool

Reads the records appended since the last call into the tally.

stop is checked before every line; once it returns true the refresh ends there, leaving the tally and cursor consistent at that line, so the next refresh resumes without losing or repeating anything. It is how a caller on a blocking thread — which cannot be cancelled from outside — gives up on a long read, e.g. the rebuild after the log was replaced.

Returns true when the tally is current as of the last complete line, and false when it may be behind: stop fired, or the log could not be read (logged at debug; best-effort like the rest of the log stack).

Trait Implementations§

Source§

impl Debug for IncrementalCounts

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more