Enum Timeliness

pub(crate) enum Timeliness {
    Strict,
    Timely,
    Unchecked,
}

How “timely” must a network directory be?

This enum is used as an argument when requesting a NetDir object from NetDirProvider and other APIs, to specify how recent the information must be in order to be useful.

Variants

Strict

The network directory must be strictly timely.

That is, it must be based on a consensus that valid right now, with no tolerance for skew or consensus problems.

Avoid using this option if you could use Timeliness::Timely instead.

Timely

The network directory must be roughly timely.

This is, it must be be based on a consensus that is not too far in the future, and not too far in the past.

(The tolerances for “too far” will depend on configuration.)

This is almost always the option that you want to use.

Unchecked

Any network directory is permissible, regardless of how untimely.

Avoid using this option if you could use Timeliness::Timely instead.

Trait Implementations

impl Clone for Timeliness

fn clone(&self) -> Timeliness

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeliness

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

Formats the value using the given formatter.

impl PartialEq for Timeliness

fn eq(&self, other: &Timeliness) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Timeliness

impl Eq for Timeliness

impl StructuralPartialEq for Timeliness