qualia_app_contract/
effects.rs1use crate::error::ContractError;
4use serde::{Deserialize, Serialize};
5use std::collections::BTreeSet;
6use std::fmt;
7
8#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
10#[serde(rename_all = "snake_case")]
11pub enum CommandEffect {
12 Read,
14 DocumentMutation,
16 WorkspaceMutation,
18 FilesystemWrite,
20 NetworkDisclosure,
22 DeviceCapture,
24 ExternalCharge,
26 PackageLifecycle,
28}
29
30impl CommandEffect {
31 pub fn as_str(&self) -> &'static str {
33 match self {
34 Self::Read => "read",
35 Self::DocumentMutation => "document_mutation",
36 Self::WorkspaceMutation => "workspace_mutation",
37 Self::FilesystemWrite => "filesystem_write",
38 Self::NetworkDisclosure => "network_disclosure",
39 Self::DeviceCapture => "device_capture",
40 Self::ExternalCharge => "external_charge",
41 Self::PackageLifecycle => "package_lifecycle",
42 }
43 }
44
45 pub fn from_str_strict(s: &str) -> Result<Self, ContractError> {
47 match s {
48 "read" => Ok(Self::Read),
49 "document_mutation" => Ok(Self::DocumentMutation),
50 "workspace_mutation" => Ok(Self::WorkspaceMutation),
51 "filesystem_write" => Ok(Self::FilesystemWrite),
52 "network_disclosure" => Ok(Self::NetworkDisclosure),
53 "device_capture" => Ok(Self::DeviceCapture),
54 "external_charge" => Ok(Self::ExternalCharge),
55 "package_lifecycle" => Ok(Self::PackageLifecycle),
56 other => Err(ContractError::UnknownEffect(other.to_string())),
57 }
58 }
59}
60
61impl fmt::Display for CommandEffect {
62 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
63 write!(f, "{}", self.as_str())
64 }
65}
66
67#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
69#[serde(transparent)]
70pub struct EffectSet(BTreeSet<CommandEffect>);
71
72impl EffectSet {
73 pub fn empty() -> Self {
75 Self(BTreeSet::new())
76 }
77
78 pub fn single(effect: CommandEffect) -> Self {
80 let mut set = BTreeSet::new();
81 set.insert(effect);
82 Self(set)
83 }
84
85 pub fn insert(&mut self, effect: CommandEffect) {
87 self.0.insert(effect);
88 }
89
90 pub fn contains(&self, effect: CommandEffect) -> bool {
92 self.0.contains(&effect)
93 }
94
95 pub fn is_read_only(&self) -> bool {
97 self.0.len() == 1 && self.0.contains(&CommandEffect::Read)
98 }
99
100 pub fn iter(&self) -> std::collections::btree_set::Iter<'_, CommandEffect> {
102 self.0.iter()
103 }
104}
105
106impl FromIterator<CommandEffect> for EffectSet {
107 fn from_iter<T: IntoIterator<Item = CommandEffect>>(iter: T) -> Self {
108 Self(iter.into_iter().collect())
109 }
110}
111
112#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
114#[serde(rename_all = "snake_case")]
115pub enum UndoPolicy {
116 None,
118 ReversibleDocument,
120 CompensatingExternal,
122}
123
124#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
126#[serde(rename_all = "snake_case")]
127pub enum InteractionKind {
128 Discrete,
130 Gesture,
132 Query,
134 View,
136 Job,
138}