Struct RecordKeeper

pub struct RecordKeeper<'a> { /* private fields */ }

A record keeper makes sure modifications done on a Managed item are all accounted for correctly.

Implementations

impl<'a> RecordKeeper<'a>

pub fn lenient(&mut self, category: DataCategory)

Marking a data category as lenient exempts this category from outcome quantity validations.

Consider using Self::modify_by instead.

This can be used in cases where the quantity is knowingly modified, which is quite common for data categories which count bytes.

pub fn modify_by(&mut self, category: DataCategory, offset: isize)

Modifies the expected count for a category.

When extracting payloads category counts may expectedly change, these changes can be tracked using this function.

Prefer using Self::modify_by over Self::lenient as lenient completely disables validation for the entire category.

impl RecordKeeper<'_>

pub fn or_default<T, E, Q>(&mut self, r: Result<T, E>, q: Q) -> T

where T: Default, E: OutcomeError, Q: Counted,

Rejects an item if the passed result is an error and returns a default value.

Similar to Self::reject_err, this emits the necessary outcomes for an item, if there is an error.

pub fn reject_err<E, Q>(&mut self, err: E, q: Q) -> E::Error

where E: OutcomeError, Q: Counted,

Rejects an item with an error.

Makes sure the correct outcomes are tracked for the item, that is discarded due to an error.

pub fn internal_error<E, Q>(&mut self, error: E, q: Q)

where E: Error + 'static, Q: Counted,

Rejects an item with an internal error.

See also: Managed::internal_error.

Trait Implementations

impl<'a> Drop for RecordKeeper<'a>

fn drop(&mut self)

Executes the destructor for this type.