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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
use std::sync::Arc;
use crate::direction::Direction;
use crate::ids::TaskId;
use crate::transfer_status::TransferStatus;
/// Immutable progress/state record emitted by transfer callbacks.
///
/// This snapshot is safe to clone and pass across threads. `file_sign` and
/// `file_name` are backed by `Arc<str>` so per-event fan-out only performs
/// a refcount bump instead of string allocation.
#[derive(Debug, Clone)]
pub struct FileTransferRecord {
/// Unique task identifier.
task_id: TaskId,
/// File signature (upload usually MD5; download may use client-defined value).
file_sign: Arc<str>,
/// Display file name.
file_name: Arc<str>,
/// Total file size in bytes.
total_size: u64,
/// Progress ratio in range `0.0..=1.0`.
progress: f32,
/// Current transfer state.
status: TransferStatus,
/// Transfer direction.
direction: Direction,
}
impl FileTransferRecord {
/// Creates a new transfer record.
///
/// # Range guidance
///
/// - `total_size >= 0`
/// - `progress` should stay in `0.0..=1.0`
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::{Direction, FileTransferRecord, TaskId, TransferStatus};
///
/// # fn sample(task_id: TaskId) {
/// let record = FileTransferRecord::new(
/// task_id,
/// "sign".to_string(),
/// "file.bin".to_string(),
/// 1024,
/// 0.5,
/// TransferStatus::Transmission,
/// Direction::Download,
/// );
/// assert_eq!(record.total_size(), 1024);
/// # }
/// ```
pub fn new(
task_id: TaskId,
file_sign: impl Into<Arc<str>>,
file_name: impl Into<Arc<str>>,
total_size: u64,
progress: f32,
status: TransferStatus,
direction: Direction,
) -> Self {
Self {
task_id,
file_sign: file_sign.into(),
file_name: file_name.into(),
total_size,
progress,
status,
direction,
}
}
/// Returns file signature.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_sign(record: &FileTransferRecord) {
/// let _ = record.file_sign();
/// }
/// ```
pub fn file_sign(&self) -> &str {
&self.file_sign
}
/// Returns display file name.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_name(record: &FileTransferRecord) {
/// let _ = record.file_name();
/// }
/// ```
pub fn file_name(&self) -> &str {
&self.file_name
}
/// Returns total file size in bytes.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_size(record: &FileTransferRecord) {
/// let _ = record.total_size();
/// }
/// ```
pub fn total_size(&self) -> u64 {
self.total_size
}
/// Returns progress ratio in range `0.0..=1.0`.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_progress(record: &FileTransferRecord) {
/// let _ = record.progress();
/// }
/// ```
pub fn progress(&self) -> f32 {
self.progress
}
/// Returns current transfer status.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_status(record: &FileTransferRecord) {
/// let _ = record.status();
/// }
/// ```
pub fn status(&self) -> &TransferStatus {
&self.status
}
/// Returns transfer direction.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_direction(record: &FileTransferRecord) {
/// let _ = record.direction();
/// }
/// ```
pub fn direction(&self) -> Direction {
self.direction
}
/// Returns task ID.
///
/// # Examples
///
/// ```no_run
/// use rusty_cat::api::FileTransferRecord;
///
/// fn read_task_id(record: &FileTransferRecord) {
/// let _ = record.task_id();
/// }
/// ```
pub fn task_id(&self) -> TaskId {
self.task_id
}
}