gitmesh-core 0.1.0

Shared types and protocol definitions for Git Mesh.
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

//! # Git Mesh Core
//!
//! This crate contains shared types, protocol definitions, and configuration logic
//! used by both the Git Mesh daemon and CLI.

use serde::{Deserialize, Serialize};

/// Requests sent from the CLI tool to the Daemon via the local IPC pipe.
#[derive(Debug, Serialize, Deserialize, Clone)]
pub enum IpcRequest {
    /// Ping the daemon to check connectivity.
    Ping,
    /// Request the current status of the daemon.
    Status,
    /// Instruct the daemon to fetch updates for a specific repository.
    Fetch { repo: String },
    /// Instruct the daemon to announce a new push for a repository.
    Push {
        /// The repository name.
        repo: String,
        /// The branch being pushed.
        branch: String,
        /// The new commit hash.
        commit: String,
    },
}

/// Responses sent from the Daemon back to the CLI over the IPC pipe.
#[derive(Debug, Serialize, Deserialize)]
pub enum IpcResponse {
    /// Response to a Ping request.
    Pong,
    /// Indicates a successful operation with an optional message.
    Success(String),
    /// Indicates a failed operation with an error message.
    Error(String),
}

/// A request sent over the P2P network using the libp2p RequestResponse protocol.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GitSyncRequest {
    /// The repository name requested.
    pub repo: String,
    /// The specific command/operation requested.
    pub command: GitSyncCommand,
}

/// Commands supported by the Git Push/Pull synchronization protocol.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum GitSyncCommand {
    /// Request a list of all refs (branches/tags) from the remote peer.
    ListRefs,
    /// Request specific objects/packfiles from the remote peer.
    FetchObjects {
        /// Commit hashes the requester already has.
        have: Vec<String>,
        /// Commit hashes the requester wants to receive.
        want: Vec<String>,
    },
}

/// A response sent over the P2P network in response to a `GitSyncRequest`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum GitSyncResponse {
    /// A list of refs available on the peer.
    Refs(Vec<(String, String)>), // (ref_name, commit_hash)
    /// A binary packfile containing the requested Git objects.
    Objects(Vec<u8>),
}