Struct AddressBookRights 

#[non_exhaustive]
pub struct AddressBookRights {
    pub may_read: bool,
    pub may_write: bool,
    pub may_share: bool,
    pub may_delete: bool,
    pub may_set_metadata: Option<bool>,
    pub extra: Map<String, Value>,
}

Access rights a principal holds on an AddressBook (RFC 9610 §2).

All four rights are booleans. Default produces all-false, which is the most restrictive valid value and a safe starting point when constructing rights in tests or server code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

may_read: bool

User may fetch the ContactCards in this AddressBook.

may_write: bool

User may create, modify, or destroy all ContactCards in this AddressBook, or move them to or from this AddressBook.

may_share: bool

User may modify the shareWith property for this AddressBook.

may_delete: bool

User may delete the AddressBook itself.

may_set_metadata: Option<bool>

User may modify the shared metadata of this AddressBook and of the ContactCards in it (draft-ietf-jmap-metadata-04 §4.1). None when the server omits it: the right is present only when the metadata capability lists this type or a type it contains (§4.1).

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

See ContactCard::extra for the collision contract: programmatically inserting a key that matches a typed field name produces a duplicate JSON object key on serialize. Treat extra as a write-only catch-all for unknown keys discovered at deserialize. JMAP-glx8.19.

See AddressBookRights::validate_extras for a runtime pre-serialize check that detects this hazard. JMAP-glx8.25.

Implementations

impl AddressBookRights

pub fn validate_extras(&self) -> Result<(), CollisionError>

Check that no extra key shadows a typed wire-format field of this struct. Returns Err(CollisionError) listing any colliding keys; otherwise returns Ok(()). See ContactCard::validate_extras for the design rationale. JMAP-glx8.25.

Errors

Returns CollisionError when one or more keys in extra match one of the camelCase wire-format names of this struct’s typed fields.

Trait Implementations

impl Clone for AddressBookRights

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressBookRights

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

Formats the value using the given formatter.

impl Default for AddressBookRights

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddressBookRights

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AddressBookRights

impl PartialEq for AddressBookRights

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AddressBookRights

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AddressBookRights