radicle-protocol 0.8.0

The Radicle Protocol
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
102
103
104
105
106
107
108
109
110
111
112

use std::collections::{BTreeMap, VecDeque};

use radicle_core::{NodeId, RepoId};

use crate::fetcher::RefsToFetch;

use super::{ActiveFetch, FetchConfig, QueuedFetch};

/// Event returned from [`FetchState::handle`].
///
/// [`FetchState::handle`]: FetchState::handle.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Event {
    Fetch(Fetch),
    Fetched(Fetched),
    Cancel(Cancel),
}

impl From<Cancel> for Event {
    fn from(v: Cancel) -> Self {
        Self::Cancel(v)
    }
}

impl From<Fetched> for Event {
    fn from(v: Fetched) -> Self {
        Self::Fetched(v)
    }
}

impl From<Fetch> for Event {
    fn from(v: Fetch) -> Self {
        Self::Fetch(v)
    }
}

/// Events that occur when a repository is requested to be fetched.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Fetch {
    /// The fetch can be started by the caller.
    Started {
        /// The repository to be fetched.
        rid: RepoId,
        /// The node to fetch from.
        from: NodeId,
        /// The references to be fetched.
        refs: RefsToFetch,
        /// The configuration options for the fetch process.
        config: FetchConfig,
    },
    /// The repository is already being fetched from the given node.
    AlreadyFetching {
        /// The repository being actively fetched.
        rid: RepoId,
        /// The node being fetched from.
        from: NodeId,
    },
    /// The queue for the given node is at capacity, and can no longer accept
    /// any more fetch requests.
    QueueAtCapacity {
        /// The rejected repository.
        rid: RepoId,
        /// The node who's queue is at capacity.
        from: NodeId,
        /// The references expected to be fetched.
        refs: RefsToFetch,
        /// The configuration options for the fetch process.
        config: FetchConfig,
        /// The capacity of the queue.
        capacity: usize,
    },
    /// The fetch was queued for later processing.
    Queued {
        /// The repository to be fetched.
        rid: RepoId,
        /// The node to fetch from.
        from: NodeId,
    },
}

/// Events that occur after a repository has been fetched.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Fetched {
    /// There was no ongoing fetch for the given [`NodeId`] and [`RepoId`].
    NotFound { from: NodeId, rid: RepoId },
    /// The active fetch was marked as completed and removed from the active
    /// set.
    Completed {
        /// The node the repository was fetched from.
        from: NodeId,
        /// The repository that was fetched.
        rid: RepoId,
        /// The references that were fetched.
        refs: RefsToFetch,
    },
}

/// Events that occur when a fetch was canceled for a given node.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Cancel {
    /// There were no active or queued fetches for the given node.
    Unexpected { from: NodeId },
    /// The were active or queued fetches that were canceled for the given node.
    Canceled {
        /// The node which was canceled.
        from: NodeId,
        /// The active fetches that were canceled.
        active: BTreeMap<RepoId, ActiveFetch>,
        /// The queued fetched that were canceled.
        queued: VecDeque<QueuedFetch>,
    },
}