Module prelude

Module prelude 

Source
Expand description

A “prelude” for crates using the willow_data_model crate.

This prelude is similar to the standard library’s prelude in that you’ll almost always want to import its entire contents, but unlike the standard library’s prelude you’ll have to do so manually:

use willow_data_model::prelude::*;

The prelude may grow over time.

Re-exports§

pub use super::entry::Entry;
pub use super::entry::EntryBuilder;
pub use super::entry::EntryBuilderError;
pub use super::entry::Entrylike;
pub use super::entry::EntrylikeExt;
pub use super::paths::Component;
pub use super::paths::InvalidComponentError;
pub use super::paths::OwnedComponent;
pub use super::paths::Path;
pub use super::paths::PathBuilder;
pub use super::paths::PathError;
pub use super::paths::PathFromComponentsError;
pub use super::authorisation::*;
pub use super::groupings::*;
pub use super::test_parameters::*;

Structs§

Duration
Defines generally usable durations for nanosecond precision valid for 32,768 centuries in either direction, and only on 80 bits / 10 octets.
Epoch
Defines a nanosecond-precision Epoch.
Format
Format allows formatting an Epoch with some custom arrangement of the Epoch items. This provides almost all of the options from the 1989 C standard.
Formatter
TimeSeries
An iterator of a sequence of evenly spaced Epochs.
Timestamp
A Willow Timestamp is a 64-bit unsigned integer, specifying the number of microseconds which have elapsed since the J2000 reference epoch (January 1, 2000, at noon, i.e., 12:00 TT) according to International Atomic Time (aka TAI).

Enums§

DurationError
Freq
An Enum to convert frequencies to their approximate duration, rounded to the closest nanosecond.
HifitimeError
Errors handles all oddities which may occur in this library.
ParsingError
TimeScale
Enum of the different time systems available
Unit
An Enum to perform time unit conversions.
Weekday

Traits§

Frequencies
A trait to automatically convert some primitives to an approximate frequency as a duration.
TimeUnits
A trait to automatically convert some primitives to a duration