plaza_wire 0.7.1

The wire format trait shared by Plaza servers and clients. Pure serde, no async runtime.
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use serde::{Deserialize, Serialize};
use std::fmt::Debug;
use std::hash::Hash;

/// Payload for an Op to insert an item into an ordered collection.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(bound = "
    CollectionKey: Serialize + for<'de2> Deserialize<'de2>,
    ItemId: Serialize + for<'de2> Deserialize<'de2>,
    ItemPayload: Serialize + for<'de2> Deserialize<'de2>
")]
pub struct InsertListItemPayload<CollectionKey, ItemId, ItemPayload>
where
    CollectionKey: Clone + Debug + Eq + Hash,
    ItemId: Clone + Debug + Eq + Hash,
    ItemPayload: Clone + Debug,
{
    pub collection_key: CollectionKey,
    pub item_id: ItemId, // Newly generated ID for the item being inserted
    pub item_payload: ItemPayload,
    /// Optional: Insert after this existing item_id. If None, usually appends to end or prepends to start.
    pub after_item_id: Option<ItemId>,
    /// Optional: Insert at a specific index. If both index and after_item_id are present,
    /// application defines precedence or how they interact. Using one is often clearer.
    pub at_index: Option<usize>,
}

/// Payload for an Op to remove an item from an ordered collection.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(bound = "
    CollectionKey: Serialize + for<'de2> Deserialize<'de2>,
    ItemId: Serialize + for<'de2> Deserialize<'de2>
")]
pub struct RemoveListItemPayload<CollectionKey, ItemId>
where
    CollectionKey: Clone + Debug + Eq + Hash,
    ItemId: Clone + Debug + Eq + Hash,
{
    pub collection_key: CollectionKey,
    pub item_id_to_remove: ItemId,
}

/// Payload for an Op to update the data of an existing item in an ordered collection.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(bound = "
    CollectionKey: Serialize + for<'de2> Deserialize<'de2>,
    ItemId: Serialize + for<'de2> Deserialize<'de2>,
    ItemPayload: Serialize + for<'de2> Deserialize<'de2>
")]
pub struct UpdateListItemPayload<CollectionKey, ItemId, ItemPayload>
where
    CollectionKey: Clone + Debug + Eq + Hash,
    ItemId: Clone + Debug + Eq + Hash,
    ItemPayload: Clone + Debug,
{
    pub collection_key: CollectionKey,
    pub item_id_to_update: ItemId,
    pub new_item_payload: ItemPayload,
}

/// Payload for an Op to move/reorder an item within an ordered collection.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(bound = "
    CollectionKey: Serialize + for<'de2> Deserialize<'de2>,
    ItemId: Serialize + for<'de2> Deserialize<'de2>
")]
pub struct MoveListItemPayload<CollectionKey, ItemId>
where
    CollectionKey: Clone + Debug + Eq + Hash,
    ItemId: Clone + Debug + Eq + Hash,
{
    pub collection_key: CollectionKey,
    pub item_id_to_move: ItemId,
    /// Optional: Move item to be after this existing item_id.
    pub new_after_item_id: Option<ItemId>,
    /// Optional: Move item to a specific new index.
    /// Application defines precedence if both are provided.
    pub new_index: Option<usize>,
}