Skip to main content

Crate jmap_tasks_server

Crate jmap_tasks_server 

Source
Expand description

JMAP Tasks extension method handlers (draft-ietf-jmap-tasks-06).

§Usage

Implement TasksBackend for your storage layer, then call register_tasks_handlers to wire all method names into a jmap_server::Dispatcher:

let mut dispatcher: Dispatcher<()> = Dispatcher::new();
register_tasks_handlers(&mut dispatcher, Arc::new(backend));

§memory feature (reference implementation)

Enable the memory feature to expose the memory::MemoryBackend reference implementation of TasksBackend. This is the same backend used by this crate’s own integration tests, intended for downstream contributors to study and for smoke tests / examples that do not want to stand up a real database. Not production. API stability is opt-in via this feature and may break across minor versions while the crate is pre-1.0.

Modules§

memorymemory
In-memory reference implementation of TasksBackend.
workflow
The Task workflowStatus and progress rule (docs/design/DECISIONS.md decision 42; jmapio/jmap #465 against draft-ietf-jmap-tasks-06 §4).

Structs§

TaskQueryArgs
Per-call Task/query arguments beyond RFC 8620 §5.5 (jmapio/jmap #456, following CalendarEvent/query, draft-ietf-jmap-calendars-34 §5.11).
TasksLimits
Implementation-defined caps of a TasksBackend, returned by TasksBackend::limits (workspace AGENTS.md “Backend caps and limits”; mirrors CalendarsLimits).

Enums§

TaskListProperty
Property selector for crate::TaskList /get and /set.
TaskNotificationProperty
Property selector for crate::TaskNotification /get.
TaskProperty
Property selector for crate::Task /get and /set.

Constants§

JMAP_TASKS_URI
Capability URI for urn:ietf:params:jmap:tasks. Capability URI for core JMAP Tasks support (draft-tasks-06 §1.6.1).

Traits§

TasksBackend
Storage backend for JMAP Tasks method handlers (draft-ietf-jmap-tasks-06).

Functions§

handle_task_changes
Handle a Task/changes method call (draft-tasks-06 §4.6).
handle_task_copy
handle_task_get
Handle a Task/get method call (draft-tasks-06 §4.5).
handle_task_get_with_history
Task/get with history (§3): handle_task_get otherwise.
handle_task_list_changes
Handle a TaskList/changes method call (draft-tasks-06 §3.6).
handle_task_list_get
Handle a TaskList/get method call (draft-tasks-06 §3.5).
handle_task_list_get_with_history
TaskList/get with history (§3): handle_task_list_get otherwise.
handle_task_list_set
Handle a TaskList/set method call (draft-tasks-06 §3.7).
handle_task_list_set_with_history
TaskList/set with restore (§5.1), then handle_task_list_set.
handle_task_notification_changes
Handle a TaskNotification/changes method call (draft-tasks-06 §5.3).
handle_task_notification_get
Handle a TaskNotification/get method call (draft-tasks-06 §5.2).
handle_task_notification_query
Handle a TaskNotification/query method call (draft-tasks-06 §5.5).
handle_task_notification_query_changes
Handle a TaskNotification/queryChanges method call (draft-tasks-06 §5.6).
handle_task_notification_set
Handle a TaskNotification/set method call (draft-tasks-06 §5.4).
handle_task_query
Handle a Task/query method call (draft-tasks-06 §4.13).
handle_task_query_changes
Handle a Task/queryChanges method call (draft-tasks-06 §4.14).
handle_task_query_changes_with_history
Task/queryChanges with onlyDestroyed (-04 §4): handle_task_query_changes otherwise.
handle_task_query_with_history
Task/query with onlyDestroyed (§4): handle_task_query otherwise.
handle_task_set
Handle a Task/set method call (draft-tasks-06 §4.7).
handle_task_set_with_history
Task/set with restore (§5.1), then handle_task_set. A restore whose taskListId names a destroyed TaskList fails as an update would; restore the TaskList in an earlier call (§5.2). Task/copy mints fresh ids, never one of a destroyed Task with history (§5.1).
register_tasks_conditional
Opt this crate’s registered Foo/set methods in to draft-ietf-jmap-conditional-02 (ifUnchangedBy and atomic; docs/design/DECISIONS.md decisions 1 and 17).
register_tasks_handlers
Register all JMAP Tasks method handlers with dispatcher.
register_tasks_handlers_with_history
register_tasks_handlers, then the history-aware /get and /set of TaskList and Task (TaskNotification has no history, decision 22) and Task /query and /queryChanges, through Dispatcher::register_history_aware (docs/design/DECISIONS.md decision 1). Call register_tasks_conditional after it, if used.