Skip to main content

StorageEventLog

Struct StorageEventLog 

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

A bounded, queryable log of StorageEvents.

When the number of stored events exceeds max_events, the oldest event is evicted on each new insertion.

Implementations§

Source§

impl StorageEventLog

Source

pub fn new(max_events: usize) -> Self

Create a new event log that retains at most max_events entries.

Source

pub fn log( &mut self, event_type: EventType, severity: EventSeverity, message: &str, block_cid: Option<&str>, metadata: HashMap<String, String>, ) -> u64

Append a new event and return its unique id.

If the log has reached max_events, the oldest event is evicted first.

Source

pub fn get_event(&self, id: u64) -> Option<&StorageEvent>

Look up an event by its id.

Source

pub fn events_by_type(&self, event_type: EventType) -> Vec<&StorageEvent>

Return all events matching the given EventType.

Source

pub fn events_by_severity(&self, severity: EventSeverity) -> Vec<&StorageEvent>

Return all events matching the given EventSeverity.

Source

pub fn events_since(&self, tick: u64) -> Vec<&StorageEvent>

Return all events whose tick is strictly greater than tick.

Source

pub fn count_by_type(&self, event_type: EventType) -> u64

Return the cumulative count of events of the given type (including evicted events).

Source

pub fn recent(&self, n: usize) -> Vec<&StorageEvent>

Return the last n events (or fewer if the log is smaller).

Source

pub fn tick(&mut self)

Advance the logical tick by one.

Source

pub fn clear(&mut self)

Remove all events from the log.

Cumulative type counts and the current tick are preserved.

Source

pub fn event_count(&self) -> usize

Return the number of events currently in the log.

Source

pub fn stats(&self) -> EventLogStats

Compute aggregate statistics over the current event log.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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