croc-sidecar 0.2.8

A wrapper for the Croc binary
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

use crate::croc::Relay;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Represents progress of an ongoing operation.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Progress {
    /// The name of the file being processed.
    pub file_name: String,
    /// The current progress percentage (0-100).
    pub percentage: u8,
    /// The number of bytes transferred so far, if available.
    pub bytes_sent: Option<u64>,
    /// The total number of bytes to transfer, if available.
    pub bytes_total: Option<u64>,
    /// The current transfer speed in bytes per second, if available.
    pub speed: Option<f64>,
}

/// Represents information about a file being transferred.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct FileInfo {
    /// The name of the file.
    pub name: String,
    /// The size of the file in bytes.
    pub size: u64,
}

/// A collection representing an event that happened in the running `croc` application.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum CrocEvent {
    /// A hashing operation is in progress.
    Hashing(Progress),
    /// Information about a file being sent.
    SendingInfo(FileInfo),
    /// Information about a file being received.
    ReceivingInfo(FileInfo),
    /// The connection code has been generated.
    CodeGenerated(String),
    /// The transfer is sending data to the specified relay/IP.
    SendingTo(Relay),
    /// The transfer is receiving data from the specified relay/IP.
    ReceivingFrom(Relay),
    /// A file is currently being sent.
    Sending(Progress),
    /// A file is currently being received.
    Receiving(Progress),
    /// The transfer has completed successfully.
    Done,
    /// An unknown line for the parser has been received.
    Unknown(String),
    /// The process has reached EOF.
    EOF,
}