Struct TimePeriod

pub(crate) struct TimePeriod {
    pub(crate) interval_num: u64,
    pub(crate) length: IntegerMinutes<u32>,
    pub(crate) epoch_offset_in_sec: u32,
}

A period of time, as used in the onion service system.

A TimePeriod is defined as a duration (in seconds), and the number of such durations that have elapsed since a given offset from the Unix epoch. So for example, the interval “(86400 seconds length, 15 intervals, 12 hours offset)”, covers 1970-01-16T12:00:00 up to but not including 1970-01-17T12:00:00.

These time periods are used to derive a different BlindedOnionIdKey during each period from each OnionIdKey.

Fields

interval_num: u64

length: IntegerMinutes<u32>

epoch_offset_in_sec: u32

Implementations

impl TimePeriod

pub fn new( length: Duration, when: SystemTime, epoch_offset: Duration, ) -> Result<TimePeriod, TimePeriodError>

Construct a time period of a given length that contains when.

The length value is rounded down to the nearest second, and must then be a whole number of minutes.

The epoch_offset value is the amount of time after the Unix epoch when our epoch begins. It is also rounded down to the nearest second.

Return None if the Duration is too large or too small, or if when cannot be represented as a time period.

pub fn from_parts( length: u32, interval_num: u64, epoch_offset_in_sec: u32, ) -> TimePeriod

Compute the TimePeriod, given its length (in minutes), index (the number of time periods that have passed since the unix epoch), and offset from the epoch (in seconds).

The epoch_offset_in_sec value is the number of seconds after the Unix epoch when our epoch begins, rounded down to the nearest second. Note that this is not the time_t at which this Time Period begins.

The returned TP begins at the time_t interval_num * length * 60 + epoch_offset_in_sec and ends length * 60 seconds later.

pub fn next(&self) -> Option<TimePeriod>

Return the time period after this one.

Return None if this is the last representable time period.

pub fn prev(&self) -> Option<TimePeriod>

Return the time period before this one.

Return None if this is the first representable time period.

pub fn contains(&self, when: SystemTime) -> bool

Return true if this time period contains when.

Limitations

This function always returns false if the time period contains any times that cannot be represented as a SystemTime.

pub fn range(&self) -> Result<Range<SystemTime>, TimePeriodError>

Return a range representing the SystemTime values contained within this time period.

Return None if this time period contains any times that can be represented as a SystemTime.

pub fn interval_num(&self) -> u64

Return the numeric index of this time period.

This function should only be used when encoding the time period for cryptographic purposes.

pub fn length(&self) -> IntegerMinutes<u32>

Return the length of this time period as a number of seconds.

This function should only be used when encoding the time period for cryptographic purposes.

pub fn epoch_offset_in_sec(&self) -> u32

Return our offset from the epoch, in seconds.

Note that this is not the start of the TP. See TimePeriod::from_parts.

Trait Implementations

impl Clone for TimePeriod

fn clone(&self) -> TimePeriod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimePeriod

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

Formats the value using the given formatter.

impl Display for TimePeriod

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

Formats the value using the given formatter.

impl KeySpecifierComponent for TimePeriod

fn to_slug(&self) -> Result<Slug, Bug>

Return the Slug representation of this type.

fn from_slug(s: &Slug) -> Result<TimePeriod, InvalidKeyPathComponentValue>

where TimePeriod: Sized,

Try to convert s into an object of this type.

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

Display the value in a human-meaningful representation

impl PartialEq for TimePeriod

fn eq(&self, other: &TimePeriod) -> 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 PartialOrd for TimePeriod

Two TimePeriods are ordered with respect to one another if they have the same interval length and offset.

fn partial_cmp(&self, other: &TimePeriod) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TimePeriod

impl Eq for TimePeriod

impl StructuralPartialEq for TimePeriod