Struct Aim 

pub struct Aim { /* private fields */ }

AIM calendar application core.

Implementations

impl Aim

pub async fn new(config: Config) -> Result<Self, Box<dyn Error>>

Creates a new AIM instance with the given configuration.

Errors

If initialization fails.

pub fn now(&self) -> DateTime<Local>

The current time in the AIM instance.

pub fn refresh_now(&mut self)

Refresh the current time to now.

pub fn default_event_draft(&self) -> EventDraft

Create a default event draft based on the AIM configuration.

pub async fn get_event( &self, id: &Id, ) -> Result<impl Event + 'static, Box<dyn Error>>

Get a event by its id.

Errors

If the event is not found or database access fails.

pub async fn new_event( &self, draft: EventDraft, ) -> Result<impl Event + 'static, Box<dyn Error>>

Add a new event from the given draft.

Errors

If the event is not found, database or file system access fails.

pub async fn update_event( &self, id: &Id, patch: EventPatch, ) -> Result<impl Event + 'static, Box<dyn Error>>

Upsert an event into the calendar.

Errors

If the event is not found, database or file system access fails.

pub async fn get_kind(&self, id: &Id) -> Result<Kind, Box<dyn Error>>

Get the kind of the given id, which can be either an event or a todo.

Errors

If the id is not found or database access fails.

pub async fn list_events( &self, conds: &EventConditions, pager: &Pager, ) -> Result<Vec<impl Event + 'static>, Box<dyn Error>>

List events matching the given conditions.

Errors

If database access fails.

pub async fn count_events(&self, conds: &EventConditions) -> Result<i64, Error>

Counts the number of events matching the given conditions.

Errors

If database access fails.

pub fn default_todo_draft(&self) -> TodoDraft

Create a default todo draft based on the AIM configuration.

pub async fn new_todo( &self, draft: TodoDraft, ) -> Result<impl Todo + 'static, Box<dyn Error>>

Add a new todo from the given draft.

Errors

If the todo is not found, database or file system access fails.

pub async fn update_todo( &self, id: &Id, patch: TodoPatch, ) -> Result<impl Todo + 'static, Box<dyn Error>>

Upsert an event into the calendar.

Errors

If the todo is not found, database or file system access fails.

pub async fn get_todo( &self, id: &Id, ) -> Result<impl Todo + 'static, Box<dyn Error>>

Get a todo by its id.

Errors

If the todo is not found or database access fails.

pub async fn list_todos( &self, conds: &TodoConditions, sort: &[TodoSort], pager: &Pager, ) -> Result<Vec<impl Todo + 'static>, Box<dyn Error>>

List todos matching the given conditions, sorted and paginated.

Errors

If database access fails.

pub async fn count_todos(&self, conds: &TodoConditions) -> Result<i64, Error>

Counts the number of todos matching the given conditions.

Errors

If database access fails.

pub async fn flush_short_ids(&self) -> Result<(), Box<dyn Error>>

Flush the short IDs to remove all entries.

Errors

If database access fails.

pub async fn close(self) -> Result<(), Box<dyn Error>>

Close the AIM instance, saving any changes to the database.

Errors

If closing the database fails.

Trait Implementations

impl Clone for Aim

fn clone(&self) -> Aim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Aim

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

Formats the value using the given formatter.