Skip to main content

SpacePatchOp

Enum SpacePatchOp 

Source
#[non_exhaustive]
pub enum SpacePatchOp { AddRole(SpaceRole), RemoveRole(Id), UpdateRole { id: Id, patch: RolePatch, }, AddMember(MemberCreate), RemoveMember(Id), UpdateMember { user_id: Id, patch: MemberPatch, }, AddChannel(ChannelCreate), RemoveChannel(Id), UpdateChannel { id: Id, patch: ChannelPatch, }, AddCategory(Category), RemoveCategory(Id), UpdateCategory { id: Id, patch: CategoryPatch, }, }
Expand description

A single Space/set update mutation operation.

Server-side handlers parse the wire JSON patch object (which has 12 pluralized keys), then unfold each array entry into a separate SpacePatchOp value. Each variant corresponds to one entry of one wire key:

Wire key (draft-atwood-jmap-chat-00 §Space/set)Variant
addRoles entrySpacePatchOp::AddRole
removeRoles entrySpacePatchOp::RemoveRole
updateRoles entrySpacePatchOp::UpdateRole
addMembers entrySpacePatchOp::AddMember
removeMembers entrySpacePatchOp::RemoveMember
updateMembers entrySpacePatchOp::UpdateMember
addChannels entrySpacePatchOp::AddChannel
removeChannels entrySpacePatchOp::RemoveChannel
updateChannels entrySpacePatchOp::UpdateChannel
addCategories entrySpacePatchOp::AddCategory
removeCategories entrySpacePatchOp::RemoveCategory
updateCategories entrySpacePatchOp::UpdateCategory

This is a Rust internal representation; it has no wire form of its own. The wire form is the pluralized patch object as defined in the draft. Round-trip JSON tests exist for the contained payload types (SpaceRole, Category, ChannelCreate, RolePatch, MemberPatch, ChannelPatch, CategoryPatch) — see this module’s test section.

For Add* variants whose payload is a server-stored type with a server-assigned id (SpaceRole, Category), the input value carries a placeholder id; the server replaces it with a real id before storing.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AddRole(SpaceRole)

Add a new role to the Space (one entry from wire key addRoles).

The contained SpaceRole’s id is a client-side placeholder. The backend MUST mint its own server-assigned id (the reference implementation uses a ULID) and surface it via the per-op result. Clients SHOULD treat the placeholder as opaque and rely on the returned id for subsequent references. Backends that honor the client-supplied id break server-side id minting and are spec-noncompliant.

§

RemoveRole(Id)

Remove a role from the Space (one entry from wire key removeRoles).

Members holding only the removed role are demoted to @everyone.

§

UpdateRole

Update an existing role (one entry from wire key updateRoles).

Fields

§id: Id
§

AddMember(MemberCreate)

Add a member to the Space (one entry from wire key addMembers).

§

RemoveMember(Id)

Remove a member from the Space (one entry from wire key removeMembers).

The owner cannot be removed.

§

UpdateMember

Update an existing member (one entry from wire key updateMembers).

Fields

§user_id: Id
§

AddChannel(ChannelCreate)

Add a channel to the Space (one entry from wire key addChannels).

The server creates a crate::Chat of kind: "channel" with the new id and spaceId set.

§

RemoveChannel(Id)

Remove a channel from the Space (one entry from wire key removeChannels).

Cascades to all Messages in the channel.

§

UpdateChannel

Update an existing channel (one entry from wire key updateChannels).

Fields

§id: Id
§

AddCategory(Category)

Add a category to the Space (one entry from wire key addCategories).

The contained Category’s id is a client-side placeholder. The backend MUST mint its own server-assigned id (the reference implementation uses a ULID) and surface it via the per-op result. Clients SHOULD treat the placeholder as opaque and rely on the returned id for subsequent references. Backends that honor the client-supplied id break server-side id minting and are spec-noncompliant.

§

RemoveCategory(Id)

Remove a category from the Space (one entry from wire key removeCategories).

Channels in the removed category move to uncategorizedChannelIds.

§

UpdateCategory

Update an existing category (one entry from wire key updateCategories).

Fields

§id: Id

Trait Implementations§

Source§

impl Clone for SpacePatchOp

Source§

fn clone(&self) -> SpacePatchOp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpacePatchOp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SpacePatchOp

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SpacePatchOp

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.