Skip to main content

Notes

Struct Notes 

Source
pub struct Notes {
    pub sidechain_events: u64,
    pub lines_skipped: u64,
    /* private fields */
}
Expand description

The observations that become a report’s notes.

Notes exist so a number a user cannot reconcile against what their agent showed them is explained rather than merely printed.

Fields§

§sidechain_events: u64§lines_skipped: u64

Implementations§

Source§

impl Notes

Source

pub fn push(&mut self, note: impl Into<String>)

Add a report-specific note, kept ahead of the shared ones.

Source

pub fn merge(&mut self, other: &Notes)

Merge another window’s observations in (compare scans twice).

Destructured rather than field-by-field on purpose: a new observation added to Notes fails to compile here until it says how it merges, instead of being silently dropped from every compare.

Source

pub fn finish(&self) -> Vec<String>

The full note list, report-specific notes first.

Trait Implementations§

Source§

impl Clone for Notes

Source§

fn clone(&self) -> Notes

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 Notes

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Notes

§

impl RefUnwindSafe for Notes

§

impl Send for Notes

§

impl Sync for Notes

§

impl Unpin for Notes

§

impl UnsafeUnpin for Notes

§

impl UnwindSafe for Notes

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

Source§

type Output = T

Should always be Self
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 = 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.