Skip to main content

AuditRing

Struct AuditRing 

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

Fixed-capacity audit ring.

Implementations§

Source§

impl AuditRing

Source

pub fn new(capacity: usize) -> Self

Creates a ring holding at most capacity entries.

§Panics

Panics if capacity is zero.

Source

pub fn set_observer(&mut self, observer: AuditObserver)

Installs observer, replacing any previous one. It sees every record appended from this point on, including records that are later overwritten before a host drains them.

Source

pub fn has_observer(&self) -> bool

Whether an observer is installed.

Source

pub fn append(&mut self, record: AuditRecord) -> u64

Appends a record, overwriting the oldest entry when full, and returns the assigned sequence number.

Source

pub fn oldest_retained(&self) -> Option<u64>

The oldest sequence number still retained.

Source

pub fn next_sequence(&self) -> u64

The sequence number the next appended record will receive.

Source

pub fn capacity(&self) -> usize

The fixed entry capacity, for capability reporting.

Source

pub fn read(&self, cursor: u64, limit: usize) -> AuditPage

Reads at most limit entries with seq >= cursor, oldest first.

Trait Implementations§

Source§

impl Debug for AuditRing

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, 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, 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.