ma-core 0.6.0

DIDComm service library: inboxes, outboxes, DID document publishing, and transport abstraction
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

//! Transport-agnostic send handle to a remote ma service.
//!
//! An `Outbox` wraps the transport details and exposes only
//! `send()` + `close()`. Created via [`crate::iroh::IrohEndpoint::outbox`].
//!
//! `send()` takes a [`Message`], validates it,
//! serializes to CBOR, and transmits. Malformed or expired messages
//! are rejected before anything hits the wire.
//!
//! Requires the `iroh` feature.
//!
//! ```ignore
//! let mut outbox = ep.outbox("did:ma:456", "ma/presence/0.0.1").await?;
//! outbox.send(&message).await?;
//! outbox.close();
//! ```

use crate::error::Result;
use crate::iroh::channel::Channel;
use did_ma::Message;

/// A transport-agnostic write handle to a remote service.
///
/// The caller doesn't need to know the underlying transport.
#[derive(Debug)]
pub struct Outbox {
    inner: OutboxTransport,
    did: String,
    protocol: String,
}

#[derive(Debug)]
enum OutboxTransport {
    Channel(Channel),
}

impl Outbox {
    /// Create an outbox backed by a channel.
    pub(crate) fn from_channel(channel: Channel, did: String, protocol: String) -> Self {
        Self {
            inner: OutboxTransport::Channel(channel),
            did,
            protocol,
        }
    }

    /// Send a ma message to the remote service.
    ///
    /// Validates the message headers, serializes to CBOR, and transmits.
    pub async fn send(&mut self, message: &Message) -> Result<()> {
        message.headers().validate()?;
        let cbor = message.to_cbor()?;
        match &mut self.inner {
            OutboxTransport::Channel(channel) => channel.send(&cbor).await,
        }
    }

    /// The DID this outbox delivers to.
    pub fn did(&self) -> &str {
        &self.did
    }

    /// The protocol this outbox is connected to.
    pub fn protocol(&self) -> &str {
        &self.protocol
    }

    /// Close the outbox gracefully.
    pub fn close(self) {
        match self.inner {
            OutboxTransport::Channel(channel) => channel.close(),
        }
    }
}