Struct Calendar 

pub struct Calendar { /* private fields */ }

Implementations

impl Calendar

pub fn create( path: &Path, config: Option<CalendarConfig>, ) -> Result<Self, CalendarError>

Create new calendar

pub fn load(path: &Path) -> Result<Self, CalendarError>

Load existing calendar

pub fn path(&self) -> &Path

pub fn config_path(&self) -> PathBuf

pub fn state(&self) -> &CalendarState

pub fn slug(&self) -> Option<&str>

pub fn events(&self) -> Result<Vec<CalendarEvent>, CalendarError>

Load all events in calendar

pub fn event(&self, event_slug: &str) -> Result<CalendarEvent, CalendarError>

Load specific event in calendar

pub fn event_by_instance_id( &self, id: &EventInstanceId, ) -> Result<Option<CalendarEvent>, CalendarError>

pub fn master_event_for( &self, uid: &str, ) -> Result<Option<Event>, CalendarError>

Find the master event of a recurring series given its uid. i.e. a master event is one whose recurrence field is set. Instance overrides (with recurrence_id set) are not considered masters.

pub fn is_read_only(&self) -> bool

pub fn name(&self) -> Option<&str>

pub fn color(&self) -> Option<&str>

pub fn read_only_setting(&self) -> Option<bool>

pub fn split_recurring_series_at( &self, master_uid: &EventUid, split_start: EventTime, split_end: EventTime, new_recurrence: Option<Recurrence>, ) -> Result<Event, CalendarError>

Split a recurring series at split_start:

Original master:

1. RRULE is truncated to end strictly before split_start
2. Any EXDATEs at or after split_start are dropped
3. Any override files at or after split_start are deleted

New master:

1. Starts at split_start
2. Inherit all other metadata (summary, description, location etc) from original
3. Gets a fresh UID and a reset SEQUENCE

pub fn delete_recurring_instance( &self, id: &EventInstanceId, ) -> Result<(), CalendarError>

Exclude a single occurrence from a recurring series i.e. “delete this instance only”

pub fn update_recurring_instance( &self, id: &EventInstanceId, apply: impl FnOnce(&mut Event), ) -> Result<CalendarEvent, CalendarError>

Override a single occurrence of a recurring series

pub fn expanded_events_in_range( &self, from: DateTime<Utc>, to: DateTime<Utc>, ) -> Result<Vec<Event>, CalendarError>

List all events occurring within time range

pub fn create_event(&self, event: Event) -> Result<CalendarEvent, CalendarError>

Create new event in calendar

pub fn delete_event(&self, event_slug: &str) -> Result<(), CalendarError>

Delete event from calendar

pub fn remote_config(&self) -> Option<&RemoteConfig>

pub fn has_remote(&self) -> bool

pub fn config(&self) -> Option<&CalendarConfig>

pub fn remote_email(&self) -> Option<&str>

pub fn base_slug_for(name: Option<&str>) -> String

Trait Implementations

impl Debug for Calendar

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

Formats the value using the given formatter.