rc-core 0.1.7

Core library for rustfs-cli S3 CLI client
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
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
//! Cluster management type definitions
//!
//! This module contains data structures for cluster management operations
//! including server information, disk status, and heal operations.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Server information representing a RustFS node
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct ServerInfo {
    /// Server state (online, offline, initializing)
    #[serde(default)]
    pub state: String,

    /// Server endpoint URL
    #[serde(default)]
    pub endpoint: String,

    /// Connection scheme (http/https)
    #[serde(default)]
    pub scheme: String,

    /// Uptime in seconds
    #[serde(default)]
    pub uptime: u64,

    /// Server version
    #[serde(default)]
    pub version: String,

    /// Git commit ID
    #[serde(default, rename = "commitID")]
    pub commit_id: String,

    /// Network interfaces
    #[serde(default)]
    pub network: HashMap<String, String>,

    /// Attached drives
    #[serde(default, rename = "drives")]
    pub disks: Vec<DiskInfo>,

    /// Pool number
    #[serde(default, rename = "poolNumber")]
    pub pool_number: i32,

    /// Memory statistics
    #[serde(default, rename = "mem_stats")]
    pub mem_stats: MemStats,
}

/// Disk information
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct DiskInfo {
    /// Disk endpoint
    #[serde(default)]
    pub endpoint: String,

    /// Whether this is a root disk
    #[serde(default, rename = "rootDisk")]
    pub root_disk: bool,

    /// Drive path
    #[serde(default, rename = "path")]
    pub drive_path: String,

    /// Whether healing is in progress
    #[serde(default)]
    pub healing: bool,

    /// Whether scanning is in progress
    #[serde(default)]
    pub scanning: bool,

    /// Disk state (online, offline)
    #[serde(default)]
    pub state: String,

    /// Disk UUID
    #[serde(default)]
    pub uuid: String,

    /// Total space in bytes
    #[serde(default, rename = "totalspace")]
    pub total_space: u64,

    /// Used space in bytes
    #[serde(default, rename = "usedspace")]
    pub used_space: u64,

    /// Available space in bytes
    #[serde(default, rename = "availspace")]
    pub available_space: u64,

    /// Pool index
    #[serde(default)]
    pub pool_index: i32,

    /// Set index
    #[serde(default)]
    pub set_index: i32,

    /// Disk index within set
    #[serde(default)]
    pub disk_index: i32,

    /// Healing info if disk is being healed
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub heal_info: Option<HealingDiskInfo>,
}

/// Healing disk information
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct HealingDiskInfo {
    /// Heal ID
    #[serde(default)]
    pub id: String,

    /// Heal session ID
    #[serde(default)]
    pub heal_id: String,

    /// Pool index
    #[serde(default)]
    pub pool_index: Option<usize>,

    /// Set index
    #[serde(default)]
    pub set_index: Option<usize>,

    /// Disk index
    #[serde(default)]
    pub disk_index: Option<usize>,

    /// Endpoint being healed
    #[serde(default)]
    pub endpoint: String,

    /// Path being healed
    #[serde(default)]
    pub path: String,

    /// Objects total count
    #[serde(default)]
    pub objects_total_count: u64,

    /// Objects total size
    #[serde(default)]
    pub objects_total_size: u64,

    /// Items healed count
    #[serde(default)]
    pub items_healed: u64,

    /// Items failed count
    #[serde(default)]
    pub items_failed: u64,

    /// Bytes done
    #[serde(default)]
    pub bytes_done: u64,

    /// Whether healing is finished
    #[serde(default)]
    pub finished: bool,

    /// Current bucket being healed
    #[serde(default)]
    pub bucket: String,

    /// Current object being healed
    #[serde(default)]
    pub object: String,
}

/// Memory statistics
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MemStats {
    /// Current allocated memory
    #[serde(default)]
    pub alloc: u64,

    /// Total allocated memory over lifetime
    #[serde(default)]
    pub total_alloc: u64,

    /// Heap allocated memory
    #[serde(default)]
    pub heap_alloc: u64,
}

/// Storage backend type
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum BackendType {
    /// Filesystem backend (single drive)
    #[default]
    #[serde(rename = "FS")]
    Fs,
    /// Erasure coding backend (distributed)
    #[serde(rename = "Erasure")]
    Erasure,
}

impl std::fmt::Display for BackendType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            BackendType::Fs => write!(f, "FS"),
            BackendType::Erasure => write!(f, "Erasure"),
        }
    }
}

/// Backend information
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct BackendInfo {
    /// Backend type
    #[serde(default, rename = "backendType")]
    pub backend_type: BackendType,

    /// Number of online disks
    #[serde(default, rename = "onlineDisks")]
    pub online_disks: usize,

    /// Number of offline disks
    #[serde(default, rename = "offlineDisks")]
    pub offline_disks: usize,

    /// Standard storage class parity
    #[serde(default, rename = "standardSCParity")]
    pub standard_sc_parity: Option<usize>,

    /// Reduced redundancy storage class parity
    #[serde(default, rename = "rrSCParity")]
    pub rr_sc_parity: Option<usize>,

    /// Total erasure sets
    #[serde(default, rename = "totalSets")]
    pub total_sets: Vec<usize>,

    /// Drives per erasure set
    #[serde(default, rename = "totalDrivesPerSet")]
    pub drives_per_set: Vec<usize>,
}

/// Cluster usage statistics
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct UsageInfo {
    /// Total storage size in bytes
    #[serde(default)]
    pub size: u64,

    /// Error message if any
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// Bucket count information
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BucketsInfo {
    /// Number of buckets
    #[serde(default)]
    pub count: u64,

    /// Error message if any
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// Object count information
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ObjectsInfo {
    /// Number of objects
    #[serde(default)]
    pub count: u64,

    /// Error message if any
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// Complete cluster information response
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct ClusterInfo {
    /// Deployment mode (distributed, standalone)
    #[serde(default)]
    pub mode: Option<String>,

    /// Domain names
    #[serde(default)]
    pub domain: Option<Vec<String>>,

    /// Region
    #[serde(default)]
    pub region: Option<String>,

    /// Deployment ID
    #[serde(default, rename = "deploymentID")]
    pub deployment_id: Option<String>,

    /// Bucket information
    #[serde(default)]
    pub buckets: Option<BucketsInfo>,

    /// Object information
    #[serde(default)]
    pub objects: Option<ObjectsInfo>,

    /// Storage usage
    #[serde(default)]
    pub usage: Option<UsageInfo>,

    /// Backend information
    #[serde(default)]
    pub backend: Option<BackendInfo>,

    /// Server information
    #[serde(default)]
    pub servers: Option<Vec<ServerInfo>>,
}

impl ClusterInfo {
    /// Get the total number of online disks across all servers
    pub fn online_disks(&self) -> usize {
        self.servers
            .as_ref()
            .map(|servers| {
                servers
                    .iter()
                    .flat_map(|s| &s.disks)
                    .filter(|d| d.state == "online" || d.state == "ok")
                    .count()
            })
            .unwrap_or(0)
    }

    /// Get the total number of offline disks across all servers
    pub fn offline_disks(&self) -> usize {
        self.servers
            .as_ref()
            .map(|servers| {
                servers
                    .iter()
                    .flat_map(|s| &s.disks)
                    .filter(|d| d.state == "offline")
                    .count()
            })
            .unwrap_or(0)
    }

    /// Get total storage capacity in bytes
    pub fn total_capacity(&self) -> u64 {
        self.servers
            .as_ref()
            .map(|servers| {
                servers
                    .iter()
                    .flat_map(|s| &s.disks)
                    .map(|d| d.total_space)
                    .sum()
            })
            .unwrap_or(0)
    }

    /// Get used storage in bytes
    pub fn used_capacity(&self) -> u64 {
        self.servers
            .as_ref()
            .map(|servers| {
                servers
                    .iter()
                    .flat_map(|s| &s.disks)
                    .map(|d| d.used_space)
                    .sum()
            })
            .unwrap_or(0)
    }
}

/// Heal operation mode
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum HealScanMode {
    /// Normal scan (default)
    #[default]
    Normal,
    /// Deep scan (slower but more thorough)
    Deep,
}

impl std::fmt::Display for HealScanMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            HealScanMode::Normal => write!(f, "normal"),
            HealScanMode::Deep => write!(f, "deep"),
        }
    }
}

impl std::str::FromStr for HealScanMode {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "normal" => Ok(HealScanMode::Normal),
            "deep" => Ok(HealScanMode::Deep),
            _ => Err(format!("Invalid heal scan mode: {s}")),
        }
    }
}

/// Request to start a heal operation
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct HealStartRequest {
    /// Bucket to heal (empty for all buckets)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bucket: Option<String>,

    /// Object prefix to heal
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub prefix: Option<String>,

    /// Scan mode
    #[serde(default)]
    pub scan_mode: HealScanMode,

    /// Whether to remove dangling objects
    #[serde(default)]
    pub remove: bool,

    /// Whether to recreate missing data
    #[serde(default)]
    pub recreate: bool,

    /// Dry run mode (don't actually heal)
    #[serde(default)]
    pub dry_run: bool,
}

/// Information about a single heal drive
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct HealDriveInfo {
    /// Drive UUID
    #[serde(default)]
    pub uuid: String,

    /// Drive endpoint
    #[serde(default)]
    pub endpoint: String,

    /// Drive state
    #[serde(default)]
    pub state: String,
}

/// Result of a heal operation on a single item
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct HealResultItem {
    /// Result index
    #[serde(default, rename = "resultId")]
    pub result_index: usize,

    /// Type of item healed (bucket, object, metadata)
    #[serde(default, rename = "type")]
    pub item_type: String,

    /// Bucket name
    #[serde(default)]
    pub bucket: String,

    /// Object key
    #[serde(default)]
    pub object: String,

    /// Version ID
    #[serde(default, rename = "versionId")]
    pub version_id: String,

    /// Detail message
    #[serde(default)]
    pub detail: String,

    /// Number of parity blocks
    #[serde(default, rename = "parityBlocks")]
    pub parity_blocks: usize,

    /// Number of data blocks
    #[serde(default, rename = "dataBlocks")]
    pub data_blocks: usize,

    /// Object size
    #[serde(default, rename = "objectSize")]
    pub object_size: u64,

    /// Drive info before healing
    #[serde(default)]
    pub before: HealDriveInfos,

    /// Drive info after healing
    #[serde(default)]
    pub after: HealDriveInfos,
}

/// Collection of heal drive infos
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct HealDriveInfos {
    /// Drive information
    #[serde(default)]
    pub drives: Vec<HealDriveInfo>,
}

/// Status of a heal operation
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct HealStatus {
    /// Heal ID
    #[serde(default)]
    pub heal_id: String,

    /// Whether healing is in progress
    #[serde(default)]
    pub healing: bool,

    /// Current bucket being healed
    #[serde(default)]
    pub bucket: String,

    /// Current object being healed
    #[serde(default)]
    pub object: String,

    /// Number of items scanned
    #[serde(default)]
    pub items_scanned: u64,

    /// Number of items healed
    #[serde(default)]
    pub items_healed: u64,

    /// Number of items failed
    #[serde(default)]
    pub items_failed: u64,

    /// Bytes scanned
    #[serde(default)]
    pub bytes_scanned: u64,

    /// Bytes healed
    #[serde(default)]
    pub bytes_healed: u64,

    /// Start time
    #[serde(default)]
    pub started: Option<String>,

    /// Last update time
    #[serde(default)]
    pub last_update: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_backend_type_display() {
        assert_eq!(BackendType::Fs.to_string(), "FS");
        assert_eq!(BackendType::Erasure.to_string(), "Erasure");
    }

    #[test]
    fn test_heal_scan_mode_display() {
        assert_eq!(HealScanMode::Normal.to_string(), "normal");
        assert_eq!(HealScanMode::Deep.to_string(), "deep");
    }

    #[test]
    fn test_heal_scan_mode_from_str() {
        assert_eq!(
            "normal".parse::<HealScanMode>().unwrap(),
            HealScanMode::Normal
        );
        assert_eq!("deep".parse::<HealScanMode>().unwrap(), HealScanMode::Deep);
        assert!("invalid".parse::<HealScanMode>().is_err());
    }

    #[test]
    fn test_cluster_info_default() {
        let info = ClusterInfo::default();
        assert!(info.mode.is_none());
        assert!(info.servers.is_none());
        assert_eq!(info.online_disks(), 0);
        assert_eq!(info.offline_disks(), 0);
    }

    #[test]
    fn test_cluster_info_disk_counts() {
        let info = ClusterInfo {
            servers: Some(vec![ServerInfo {
                disks: vec![
                    DiskInfo {
                        state: "online".to_string(),
                        ..Default::default()
                    },
                    DiskInfo {
                        state: "online".to_string(),
                        ..Default::default()
                    },
                    DiskInfo {
                        state: "offline".to_string(),
                        ..Default::default()
                    },
                ],
                ..Default::default()
            }]),
            ..Default::default()
        };

        assert_eq!(info.online_disks(), 2);
        assert_eq!(info.offline_disks(), 1);
    }

    #[test]
    fn test_cluster_info_capacity() {
        let info = ClusterInfo {
            servers: Some(vec![ServerInfo {
                disks: vec![
                    DiskInfo {
                        total_space: 1000,
                        used_space: 300,
                        ..Default::default()
                    },
                    DiskInfo {
                        total_space: 2000,
                        used_space: 500,
                        ..Default::default()
                    },
                ],
                ..Default::default()
            }]),
            ..Default::default()
        };

        assert_eq!(info.total_capacity(), 3000);
        assert_eq!(info.used_capacity(), 800);
    }

    #[test]
    fn test_disk_info_default() {
        let disk = DiskInfo::default();
        assert!(disk.endpoint.is_empty());
        assert!(!disk.healing);
        assert!(!disk.scanning);
        assert_eq!(disk.total_space, 0);
    }

    #[test]
    fn test_server_info_default() {
        let server = ServerInfo::default();
        assert!(server.state.is_empty());
        assert!(server.endpoint.is_empty());
        assert_eq!(server.uptime, 0);
    }

    #[test]
    fn test_heal_start_request_default() {
        let req = HealStartRequest::default();
        assert!(req.bucket.is_none());
        assert!(req.prefix.is_none());
        assert_eq!(req.scan_mode, HealScanMode::Normal);
        assert!(!req.remove);
        assert!(!req.dry_run);
    }

    #[test]
    fn test_heal_status_default() {
        let status = HealStatus::default();
        assert!(status.heal_id.is_empty());
        assert!(!status.healing);
        assert_eq!(status.items_scanned, 0);
    }

    #[test]
    fn test_serialization() {
        let info = ClusterInfo {
            mode: Some("distributed".to_string()),
            deployment_id: Some("test-123".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&info).unwrap();
        assert!(json.contains("distributed"));
        assert!(json.contains("test-123"));

        let deserialized: ClusterInfo = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.mode, Some("distributed".to_string()));
    }
}