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§
- memory
memory - In-memory reference implementation of
TasksBackend. - workflow
- The Task
workflowStatusandprogressrule (docs/design/DECISIONS.md decision 42; jmapio/jmap #465 against draft-ietf-jmap-tasks-06 §4).
Structs§
- Task
Query Args - Per-call
Task/queryarguments beyond RFC 8620 §5.5 (jmapio/jmap #456, following CalendarEvent/query, draft-ietf-jmap-calendars-34 §5.11). - Tasks
Limits - Implementation-defined caps of a
TasksBackend, returned byTasksBackend::limits(workspace AGENTS.md “Backend caps and limits”; mirrorsCalendarsLimits).
Enums§
- Task
List Property - Property selector for
crate::TaskList/getand/set. - Task
Notification Property - Property selector for
crate::TaskNotification/get. - Task
Property - Property selector for
crate::Task/getand/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§
- Tasks
Backend - Storage backend for JMAP Tasks method handlers (draft-ietf-jmap-tasks-06).
Functions§
- handle_
task_ changes - Handle a
Task/changesmethod call (draft-tasks-06 §4.6). - handle_
task_ copy - handle_
task_ get - Handle a
Task/getmethod call (draft-tasks-06 §4.5). - handle_
task_ get_ with_ history Task/getwith history (§3):handle_task_getotherwise.- handle_
task_ list_ changes - Handle a
TaskList/changesmethod call (draft-tasks-06 §3.6). - handle_
task_ list_ get - Handle a
TaskList/getmethod call (draft-tasks-06 §3.5). - handle_
task_ list_ get_ with_ history TaskList/getwith history (§3):handle_task_list_getotherwise.- handle_
task_ list_ set - Handle a
TaskList/setmethod call (draft-tasks-06 §3.7). - handle_
task_ list_ set_ with_ history TaskList/setwithrestore(§5.1), thenhandle_task_list_set.- handle_
task_ notification_ changes - Handle a
TaskNotification/changesmethod call (draft-tasks-06 §5.3). - handle_
task_ notification_ get - Handle a
TaskNotification/getmethod call (draft-tasks-06 §5.2). - handle_
task_ notification_ query - Handle a
TaskNotification/querymethod call (draft-tasks-06 §5.5). - handle_
task_ notification_ query_ changes - Handle a
TaskNotification/queryChangesmethod call (draft-tasks-06 §5.6). - handle_
task_ notification_ set - Handle a
TaskNotification/setmethod call (draft-tasks-06 §5.4). - handle_
task_ query - Handle a
Task/querymethod call (draft-tasks-06 §4.13). - handle_
task_ query_ changes - Handle a
Task/queryChangesmethod call (draft-tasks-06 §4.14). - handle_
task_ query_ changes_ with_ history Task/queryChangeswithonlyDestroyed(-04 §4):handle_task_query_changesotherwise.- handle_
task_ query_ with_ history Task/querywithonlyDestroyed(§4):handle_task_queryotherwise.- handle_
task_ set - Handle a
Task/setmethod call (draft-tasks-06 §4.7). - handle_
task_ set_ with_ history Task/setwithrestore(§5.1), thenhandle_task_set. A restore whosetaskListIdnames 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 (
ifUnchangedByandatomic; 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/getand/setof TaskList and Task (TaskNotification has no history, decision 22) and Task/queryand/queryChanges, throughDispatcher::register_history_aware(docs/design/DECISIONS.md decision 1). Callregister_tasks_conditionalafter it, if used.