cortexfs-channels 0.1.0

Runtime-neutral multi-channel messaging abstractions for agents.
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
80
81
82
83
84

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

use crate::{ChannelError, ChannelId, ConversationId};

/// Sender identity supplied by the platform adapter.
#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
pub struct Participant {
    pub id: String,
    pub display_name: Option<String>,
    pub handle: Option<String>,
}

/// Text plus optional platform-neutral attachment references.
#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
pub struct MessageBody {
    pub text: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<Attachment>,
}

impl MessageBody {
    pub fn text(value: impl Into<String>) -> Result<Self, ChannelError> {
        let body = Self {
            text: value.into(),
            attachments: Vec::new(),
        };
        body.validate()?;
        Ok(body)
    }

    pub fn validate(&self) -> Result<(), ChannelError> {
        if self.text.is_empty() && self.attachments.is_empty() {
            return Err(ChannelError::InvalidMessage(
                "message body is empty".to_owned(),
            ));
        }
        if self.text.contains('\0') {
            return Err(ChannelError::InvalidMessage(
                "message text contains NUL".to_owned(),
            ));
        }
        Ok(())
    }
}

/// A remote attachment represented by a retrievable URL.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct Attachment {
    pub url: String,
    pub name: Option<String>,
    pub mime: Option<String>,
}

/// Stable destination identity used by both inbound and outbound messages.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct MessageTarget {
    pub channel: ChannelId,
    pub conversation: ConversationId,
    pub thread: Option<String>,
    pub reply_to: Option<String>,
}

/// A message delivered by a channel adapter.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct InboundMessage {
    pub id: String,
    pub target: MessageTarget,
    pub sender: Participant,
    pub body: MessageBody,
    pub timestamp_ms: Option<u64>,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub metadata: BTreeMap<String, String>,
}

/// A message sent through a channel adapter.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct OutboundMessage {
    pub target: MessageTarget,
    pub body: MessageBody,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub metadata: BTreeMap<String, String>,
}