Struct HealthState 

pub struct HealthState {
    pub taken: BTreeMap<String, i64>,
    pub reminded: BTreeMap<String, i64>,
    pub unshown: BTreeMap<String, i64>,
    pub not_taken: BTreeMap<String, i64>,
    pub moved: BTreeMap<String, [i64; 2]>,
    pub errands: BTreeMap<String, String>,
    pub chat_day: Option<Date>,
    pub chat_minutes: u32,
    pub chats_locked_until: Option<i64>,
}

What is marked of the doses and done of the errands, kept apart from the health file: $XDG_STATE_HOME/sioul/health-state.toml.

Fields

taken: BTreeMap<String, i64>

Doses marked taken, by key, when (Unix seconds); kept a week.

reminded: BTreeMap<String, i64>

Doses already reminded, by key; kept a week.

unshown: BTreeMap<String, i64>

Doses whose reminder could not be shown while Sioul ran (a desktop without a notification server), by key, when it was tried; kept a week. Not a reminder: such a dose is still asked about afterwards, under its own heading, since Sioul ran (unanswered). Written only when there is one: an older Sioul’s file stays as it was.

not_taken: BTreeMap<String, i64>

Doses answered “not taken” when asked afterwards, by key; kept a week.

moved: BTreeMap<String, [i64; 2]>

Doses whose take moved the next ones, by key: where they started before and after (Health::taken_at); kept with the mark.

errands: BTreeMap<String, String>

Errands whose task was made, by key.

chat_day: Option<Date>

Chats: the day counted, the minutes used that day, and covered until when.

chat_minutes: u32

chats_locked_until: Option<i64>

Implementations

impl HealthState

pub fn default_path() -> PathBuf

pub fn read(path: &Path) -> Result<HealthState, Unsound>

The doses’ record as written, or why it cannot be trusted. Never an empty record in place of one that does not read: a dose taken would look not taken, and written back empty, the sharing would take every mark out on your other devices too. Of no bytes at all, or gone, though written before (witnessed): lost (a crash after a write that had not reached the disk, a full disk, a state folder wiped).

pub fn update<T>( path: &Path, now: i64, change: impl FnOnce(&mut HealthState) -> T, ) -> Result<T, Problem>

The record changed by change, one writer at a time (the window, the sharing: filelock): read again, changed, written, under the lock, so that no change made meanwhile is written over.

pub fn set_aside(path: &Path, now: i64) -> Result<Option<PathBuf>, String>

A record that cannot be trusted, kept aside as <name>.unreadable-<time> for whoever wants to look, with its witness: a new one can start. Only once nothing it held can be taken out elsewhere (share::rebuild).

pub fn save(&mut self, path: &Path, now: i64) -> Result<(), String>

Saved, its marks older than a week dropped. Use update: it holds the lock.

pub fn to_remind(&self, health: &Health, now: &Zoned, minutes: i64) -> Vec<Dose>

The doses to remind now: due in the last minutes, not taken, not reminded yet.

pub fn unanswered( &self, health: &Health, now: &Zoned, hours: i64, grace: i64, ) -> Vec<Dose>

The doses of the last hours, past their time by grace minutes, neither marked nor reminded: due while Sioul ran nowhere, or while it ran but could not show their reminder (unshown, reminder_unshown). Asked about afterwards, as a question on the past; never reminded to take now.

pub fn reminder_unshown(&self, key: &str) -> bool

Whether Sioul ran when key fell due but could not show its reminder (no notification server), here or on another device that shares its doses: its question then says so, never “while Sioul was closed”.

pub fn due_today( &self, health: &Health, now: &Zoned, hours: i64, grace: i64, ) -> Vec<Dose>

Today’s doses from their time on, not marked yet (taken, or said not taken), for the Porch: reminded or not, since a reminder can go unseen; until marked, until the day ends, or hours after their time (as far back as a dose is asked about). Those due while Sioul ran nowhere (unanswered) are asked about apart, and left out here.

pub fn chat_minute(&mut self, limit: &ChatLimit, now: &Zoned) -> bool

One more minute of chats today; covered once the day’s limit is reached. Returns whether chats are covered now.

pub fn chats_covered(&self, now: &Zoned) -> bool

Whether chats are covered now.

Trait Implementations

impl Clone for HealthState

fn clone(&self) -> HealthState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthState

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

Formats the value using the given formatter.

impl Default for HealthState

fn default() -> HealthState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HealthState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HealthState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HealthState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HealthState