Struct Settings 

pub struct Settings {

    pub week: [Room; 7],
    pub days: BTreeMap<Date, Room>,
    pub windows: Vec<AdminWindow>,
    pub anything: bool,
    pub hours: Week,
    pub areas: TaskAreas,
    pub pause: u32,
    pub default_estimate: u32,
    pub today_percent: u32,
    pub closed: BTreeSet<Date>,
    pub office_days: [bool; 7],
    pub office_hours: Vec<AdminWindow>,
    pub heavy_today: u32,
    pub heavy_per_day: u32,
    pub needs: Needs,
    pub shifts: BTreeMap<String, i64>,
    pub needs_days: Days,
    pub capacity: Planning,
    pub extension: Option<(i64, i64)>,
    pub light_only: u32,
    pub pins: BTreeMap<String, Pin>,
    pub records: BTreeMap<String, (i64, i64)>,
}

How much room the days have for tasks: your hours, each for what it is for.

Fields

week: [Room; 7]

The week’s hours as room, Monday first.

days: BTreeMap<Date, Room>

Days whose room is not their weekday’s: today from now on, the days with events, the events taken out (with_events).

windows: Vec<AdminWindow>

The week’s hours as written, for the day’s layout (dayview).

anything: bool

No hours set at all: offices’ usual hours, open to every task.

hours: Week

Which kinds of hours the week sets: what has none of its own goes where areas::in_view says.

areas: TaskAreas

What each task is for: its own area, else its categories and projects.

pause: u32

Minutes of pause after each step, taken from the room too.

default_estimate: u32

Minutes counted for a task without an estimate.

today_percent: u32

Today’s share of its usual room, in percent: the day’s weather (today).

closed: BTreeSet<Date>

Days without room, whatever their weekday: time off, a day stopped early.

office_days: [bool; 7]

The weekdays offices open, Monday first: tasks that need one go only there.

office_hours: Vec<AdminWindow>

Offices’ usual hours (Config::office_hours): the day’s layout puts a task that needs an office, without hours of its own, only while they are open.

heavy_today: u32

Heavy tasks today takes (its weather), and any other day.

heavy_per_day: u32

needs: Needs

Meals, naps and the night: kept free of tasks (with_needs).

shifts: BTreeMap<String, i64>

Today’s meals pushed past its events, by key, in minutes (Needs::past_events_on).

needs_days: Days

Each day’s own meals, naps and nights: moved, changed, taken out, added (with_days).

capacity: Planning

What your record says (capacity): ratings, corrected lengths, budgets, free time, the gain slot. Its default changes nothing.

extension: Option<(i64, i64)>

Today’s end of work moved by free time: (usual end, moved end), Unix seconds (with_extension, docs/pauses.md). Hours, not capacity: the budgets do not see it, and only light steps go there.

light_only: u32

Minutes of today’s room in it, kept for light steps (with_events).

pins: BTreeMap<String, Pin>

Tasks pinned to a time (blocks), by UID: each laid in its block, the block’s time out of its day’s room (with_pins, before with_events).

records: BTreeMap<String, (i64, i64)>

Tasks done, by UID: the block that held their work, (start, end) in Unix seconds, where the day shows them done.

Implementations

impl Settings

pub fn of_hours(windows: &[AdminWindow], areas: TaskAreas) -> Settings

The room your week’s hours give (Config::week_hours), each kind for its own tasks; none set: offices’ usual hours, for everything.

pub fn flat(minutes: [u32; 7]) -> Settings

The same minutes each weekday, Monday first, open to every task, no pause: for tests and simple plans.

pub fn with_needs( self, needs: &Needs, shifts: BTreeMap<String, i64>, ) -> Settings

Meals, naps and the night kept free of tasks, every day (shifts: today’s moved by its events, by key, in minutes). Before with_events, which keeps them free on the days it lays out too.

pub fn with_days(self, days: Days) -> Settings

Each day’s own meals, naps and nights (needs::Days): before with_events, which lays out each day changed on its own.

pub fn with_pins(self, blocks: Blocks) -> Settings

The tasks pinned to a time (blocks::Blocks): before with_events, which takes each block’s time, its margins and a pause around it, out of its day’s room, as an event’s. Counted once: the plan lays the task there without taking room again, and the block is no event of its own.

pub fn kept_on( &self, date: Date, zone: &TimeZone, today: Date, ) -> Vec<(i64, i64)>

The times kept free on date, as that day has them; today’s meals moved past its events as said (shifts).

fn kept_held( &self, date: Date, zone: &TimeZone, today: Date, held: &[(i64, i64)], ) -> Vec<(i64, i64)>

The same, another day’s meals moved past the events it holds (held: their times with their margins), as today’s are.

pub fn with_extension(self, extension: Option<(i64, i64)>) -> Settings

Today’s end of work moved by free time, (usual end, moved end): before with_events, which gives today the room, light steps only there.

pub fn extension_on(&self, date: Date, zone: &TimeZone) -> Vec<(i64, i64)>

The moved end’s stretch on date, outside the hours already there: none on another day (docs/pauses.md).

fn extra_on( &self, date: Date, zone: &TimeZone, hours: &[(i64, i64, Area)], ) -> Vec<(i64, i64, Area)>

pub fn hours_on(&self, date: Date, zone: &TimeZone) -> Vec<(i64, i64, Area)>

date’s hours as stretches, in order, the moved end of work included.

pub fn with_events(self, now: &Zoned, events: &[Occurrence]) -> Settings

Today from now on, and the coming days with events: the events taken out of their hours, a pause before and after each (appointments, meetings).

pub fn room_on(&self, date: Date) -> &Room

A day’s room: its own when it has events or is today, else its weekday’s.

pub fn usable(&self, task: &Task) -> Area

The kinds of hours a task can take: those of its area, and those areas::in_view lends what has no hours of its own. A call to an office, as quiet::QuietTasks::keeps shows it: work and admin hours, never leisure, as offices keep business hours (docs/areas.md).

pub fn rest_days(&self) -> [bool; 7]

The weekdays without any hours, Monday first.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Settings

Offices’ usual hours, Monday to Friday 9:00 to 17:00, open to every task, until yours are set.