jmap-types 0.4.1

Shared JMAP wire types (RFC 8620) for the jmap-* crate family
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Shared JMAP wire types for RFC 8620.
//!
//! Provides [`Id`], [`UTCDate`], [`State`], [`JmapError`],
//! [`JmapRequest`], [`JmapResponse`], [`Filter`], [`ResultReference`], and
//! the RFC 8620 §7 push types ([`StateChange`], [`PushSubscription`]), and
//! the draft-atwood-jmap-object-uri-00 object reference [`JmapUri`] —
//! the primitives shared by all crates in the `jmap-*` family.
//!
//! This crate is types-only: no method handlers, no async, no network I/O.
//! It is the root dependency for `jmap-mail-types`, `jmap-chat-types`, and
//! all server and client crates in the family.
//!
//! All types implement [`serde::Serialize`] and [`serde::Deserialize`] with the
//! camelCase field names required by the JMAP wire format.
//!
//! # Example
//!
//! ```rust
//! use jmap_types::JmapRequest;
//!
//! let json = r#"{
//!     "using": ["urn:ietf:params:jmap:core"],
//!     "methodCalls": [["Mailbox/get", {"accountId": "a1"}, "c0"]]
//! }"#;
//!
//! let req: JmapRequest = serde_json::from_str(json).unwrap();
//! assert_eq!(req.using[0], "urn:ietf:params:jmap:core");
//! assert_eq!(req.method_calls[0].name, "Mailbox/get");
//! ```

#![forbid(unsafe_code)]

mod backend;
mod error;
mod id;
mod jmap_uri;
mod methods;
mod patch;
mod push;
mod query;
mod resultref;
mod set_error;
mod wire;

// `string_enum` is a private module that hosts the [`impl_string_enum!`]
// declarative macro. The macro itself is `#[macro_export]`-ed, so it is
// reachable as `jmap_types::impl_string_enum!` regardless of this `mod`'s
// visibility. See bd JMAP-wk77.
mod string_enum;

pub use backend::{GetObject, JmapObject, QueryObject, SetObject, check_property_classification};
pub use error::{JmapError, MethodErrorType, json_type_name};
pub use id::{Date, Id, State, UTCDate, ValidationError};
pub use jmap_uri::{JmapUri, JmapUriError};
pub use methods::{
    AddedItem, ChangesResponse, CopyResponse, GetResponse, PartialObject, QueryChangesResponse,
    QueryResponse, SetResponse,
};
pub use patch::PatchObject;
pub use push::{PushKeys, PushSubscription, PushVerification, StateChange, Urgency};
pub use query::{Filter, FilterOperator, Operator};
pub use resultref::{Argument, ResultReference};
pub use set_error::{ReservedExtrasKey, SetError, SetErrorType};
pub use wire::{Invocation, JmapRequest, JmapResponse};