Struct State

pub struct State { /* private fields */ }

The persistent Timekeeper state.

See the method documentation for the specific components of the state that is being persisted.

Implementations

impl State

pub fn new(update_rtc: bool) -> Self

pub fn may_update_rtc(&self) -> bool

Returns whether updating the RTC clock is allowed.

pub fn set_may_update_rtc(&mut self, update_rtc: bool)

pub fn get_rtc_reference(&self) -> (BootInstant, Instant<UtcTimeline>)

Gets a known-good reference point on the boot-to-utc affine transform.

pub fn set_rtc_reference( &mut self, boot_reference: BootInstant, utc_reference: Instant<UtcTimeline>, )

Sets a known-good reference point on the boot-to-utc affine transform.

This setting can be used to recover a known-good UTC estimate.

Args

• boot_reference: a reference instant on the boot timeline.
• utc_reference: a reference instant on the UTC timeline that corresponds to boot_timeline.

pub fn read_and_update() -> Result<Self>

Reads the persistent state, updating the testing-only components.

pub fn read_and_update_internal<P: AsRef<Path>>(path: P) -> Result<Self>

pub fn write(state: &Self) -> Result<()>

Write the persistent state to mutable persistent storage.

pub fn write_internal<P: AsRef<Path>>(path: P, state: &Self) -> Result<()>

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for State

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for State

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.