Struct routinator::payload::SharedHistory

pub struct SharedHistory(_);

A shareable history of the validated payload.

Implementations

impl SharedHistory

pub fn from_config(config: &Config) -> Self

Creates a new shared history from the configuration.

pub fn read(&self) -> impl Deref<Target = PayloadHistory> + '_

Provides access to the underlying history.

pub fn update(
    &self,
    report: ValidationReport,
    exceptions: &LocalExceptions,
    metrics: Metrics
) -> bool

Updates the history.

Produces a new snapshot based on a validation report and local exceptions. If this snapshot differs from the current one, adds a new version to the history.

The method returns whether it has indeed added a new version.

pub fn mark_update_start(&self)

Marks the beginning of an update cycle.

pub fn mark_update_done(&self)

Marks the end of an update cycle.

Trait Implementations

impl Clone for SharedHistory

fn clone(&self) -> SharedHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedHistory

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

Formats the value using the given formatter.

impl VrpSource for SharedHistory

type FullIter = SnapshotVrpIter

An iterator over the complete set of VRPs.

type DiffIter = DeltaVrpIter

An iterator over a difference between two sets of VRPs.

fn ready(&self) -> bool

Returns whether the source is ready to serve data.

fn notify(&self) -> State

Returns the current state of the source.

fn full(&self) -> (State, Self::FullIter)

Returns the current state and an iterator over the full set of VRPs.

fn diff(&self, state: State) -> Option<(State, Self::DiffIter)>

Returns the current state and an interator over differences in VPRs.

fn timing(&self) -> Timing

Returns the timing information for the current state.