eidetica 0.2.0

Decentralized DB. Remember Everything. Everywhere. All At Once.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Transport abstractions for sync communication.
//!
//! This module defines the transport trait that different network
//! implementations must implement, allowing the sync module to
//! work over various protocols (HTTP, Iroh, Bluetooth, etc.).

use std::sync::Arc;

use async_trait::async_trait;

use crate::{
    Entry, Result,
    sync::{
        handler::SyncHandler,
        peer_types::Address,
        protocol::{SyncRequest, SyncResponse},
    },
};

pub mod http;
pub mod iroh;
pub mod shared;

/// Trait for implementing sync communication over different transports.
///
/// Each transport implementation (HTTP, Iroh, etc.) must
/// implement this trait to provide server and client functionality.
#[async_trait]
pub trait SyncTransport: Send + Sync {
    /// Check if this transport can handle the given address
    ///
    /// # Arguments
    /// * `address` - The address to check
    ///
    /// # Returns
    /// True if this transport can handle the address, false otherwise.
    fn can_handle_address(&self, address: &Address) -> bool;

    /// Start a server listening on the specified address with a sync handler.
    ///
    /// # Arguments
    /// * `addr` - The address to bind the server to (use port 0 for automatic port assignment)
    /// * `handler` - The sync handler to process incoming requests
    ///
    /// # Returns
    /// A Result indicating success or failure of server startup.
    async fn start_server(&mut self, addr: &str, handler: Arc<dyn SyncHandler>) -> Result<()>;

    /// Stop the running server gracefully.
    ///
    /// # Returns
    /// A Result indicating success or failure of server shutdown.
    async fn stop_server(&mut self) -> Result<()>;

    /// Send a sync request to a peer and receive a response.
    ///
    /// # Arguments
    /// * `address` - The address of the peer to connect to
    /// * `request` - The sync request to send
    ///
    /// # Returns
    /// The response from the peer, or an error if the request failed.
    async fn send_request(&self, address: &Address, request: &SyncRequest) -> Result<SyncResponse>;

    /// Send entries to a sync peer and ensure they are acknowledged.
    ///
    /// This is a convenience method that wraps send_request and validates the response.
    ///
    /// # Arguments
    /// * `address` - The address of the peer to connect to
    /// * `entries` - The entries to send
    ///
    /// # Returns
    /// A Result indicating whether the entries were successfully acknowledged.
    async fn send_entries(&self, address: &Address, entries: &[Entry]) -> Result<()> {
        let request = SyncRequest::SendEntries(entries.to_vec());
        let response = self.send_request(address, &request).await?;
        match response {
            SyncResponse::Ack | SyncResponse::Count(_) => Ok(()),
            SyncResponse::Error(msg) => Err(crate::sync::SyncError::Network(msg).into()),
            _ => Err(crate::sync::SyncError::UnexpectedResponse {
                expected: "Ack or Count",
                actual: format!("{response:?}"),
            }
            .into()),
        }
    }

    /// Check if the server is currently running.
    ///
    /// # Returns
    /// True if the server is running, false otherwise.
    fn is_server_running(&self) -> bool;

    /// Get the address the server is currently bound to.
    ///
    /// # Returns
    /// The server address if running, or an error if no server is running.
    /// Useful when the server was started with port 0 for dynamic port assignment.
    fn get_server_address(&self) -> Result<String>;
}