Skip to main content

SightingLog

Struct SightingLog 

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

A bounded store for Sightings: at most cap per (format, shape, kind) are kept, so the memory one scan spends on them is at most groups x cap however hostile the input, while the count of each group stays exact. Self::count gives the exact total pushed, and Self::into_sightings folds the uncounted remainder into the last stored sighting’s Sighting::more, so describe_sightings prints the same sentence it would for every sighting stored.

Implementations§

Source§

impl SightingLog

Source

pub const DEFAULT_CAP: usize = 64

The default per-group cap.

Source

pub fn new() -> Self

An empty log with Self::DEFAULT_CAP.

Source

pub fn with_cap(cap: usize) -> Self

An empty log keeping at most cap sightings per group. A cap of 0 is raised to 1, so a group always has a sighting to carry its count.

A cap below 8 (SIGHTING_OFFSETS_SHOWN) CHANGES the sentence describe_sightings prints: it lists only the stored offsets, so a group holding more than cap would show fewer offsets and a larger “and N more” than an uncapped list. The count stays exact either way.

Source

pub fn push(&mut self, sighting: Sighting)

Record sighting: stored while its group holds fewer than the cap, and always counted. A sighting’s own Sighting::more is counted too.

Source

pub fn count( &self, format: FormatId, shape: &'static str, kind: SightingKind, ) -> u64

The exact number of sightings of this group pushed, stored or not.

Source

pub fn is_empty(&self) -> bool

Whether nothing has been pushed.

Source

pub fn into_sightings(self) -> Vec<Sighting>

The stored sightings, groups in first-seen order, each group’s last one carrying the count of those not stored in Sighting::more.

The offsets kept are the first cap of each group in PUSH order, so a scanner that wants the smallest listed must push each group in ascending offset order.

Trait Implementations§

Source§

impl Clone for SightingLog

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SightingLog

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SightingLog

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.