openigtlink-rust 0.3.2

Rust implementation of the OpenIGTLink protocol for image-guided therapy
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
//! Partial message transfer for large messages
//!
//! Supports chunked transfer of large messages (images, video) with
//! resume capability and progress tracking.

use crate::error::{IgtlError, Result};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::Mutex;
use tracing::{debug, info, trace, warn};

/// Configuration for partial message transfer
#[derive(Debug, Clone)]
pub struct TransferConfig {
    /// Size of each chunk in bytes
    pub chunk_size: usize,
    /// Whether to allow resume after interruption
    pub allow_resume: bool,
    /// Timeout for transfer session (None = no timeout)
    pub timeout_secs: Option<u64>,
}

impl Default for TransferConfig {
    fn default() -> Self {
        Self {
            chunk_size: 65536, // 64KB chunks
            allow_resume: true,
            timeout_secs: Some(300), // 5 minutes
        }
    }
}

/// Unique identifier for a transfer session
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct TransferId(u64);

impl TransferId {
    pub fn new(id: u64) -> Self {
        Self(id)
    }

    pub fn value(&self) -> u64 {
        self.0
    }
}

/// State of a partial transfer session
#[derive(Debug, Clone)]
pub enum TransferState {
    /// Transfer is in progress
    InProgress {
        /// Bytes transferred so far
        bytes_transferred: usize,
        /// Total bytes to transfer
        total_bytes: usize,
        /// Current chunk index
        chunk_index: usize,
    },
    /// Transfer completed successfully
    Completed {
        /// Total bytes transferred
        total_bytes: usize,
    },
    /// Transfer was interrupted
    Interrupted {
        /// Bytes transferred before interruption
        bytes_transferred: usize,
        /// Total bytes
        total_bytes: usize,
        /// Can resume from this point
        resumable: bool,
    },
    /// Transfer failed
    Failed {
        /// Error message
        error: String,
    },
}

impl TransferState {
    /// Get progress percentage (0.0 - 1.0)
    pub fn progress(&self) -> f64 {
        match self {
            Self::InProgress {
                bytes_transferred,
                total_bytes,
                ..
            } => {
                if *total_bytes > 0 {
                    (*bytes_transferred as f64) / (*total_bytes as f64)
                } else {
                    0.0
                }
            }
            Self::Completed { .. } => 1.0,
            Self::Interrupted {
                bytes_transferred,
                total_bytes,
                ..
            } => {
                if *total_bytes > 0 {
                    (*bytes_transferred as f64) / (*total_bytes as f64)
                } else {
                    0.0
                }
            }
            Self::Failed { .. } => 0.0,
        }
    }

    /// Check if transfer is complete
    pub fn is_complete(&self) -> bool {
        matches!(self, Self::Completed { .. })
    }

    /// Check if transfer can be resumed
    pub fn is_resumable(&self) -> bool {
        matches!(
            self,
            Self::Interrupted {
                resumable: true,
                ..
            }
        )
    }
}

/// Information about a transfer session
#[derive(Debug, Clone)]
pub struct TransferInfo {
    pub id: TransferId,
    pub state: TransferState,
    pub config: TransferConfig,
    pub started_at: std::time::Instant,
    pub updated_at: std::time::Instant,
}

impl TransferInfo {
    /// Get elapsed time since transfer started
    pub fn elapsed(&self) -> std::time::Duration {
        self.started_at.elapsed()
    }

    /// Get time since last update
    pub fn idle_time(&self) -> std::time::Duration {
        self.updated_at.elapsed()
    }

    /// Calculate transfer speed in bytes/sec
    pub fn speed_bps(&self) -> f64 {
        match &self.state {
            TransferState::InProgress {
                bytes_transferred, ..
            }
            | TransferState::Interrupted {
                bytes_transferred, ..
            } => {
                let elapsed_secs = self.elapsed().as_secs_f64();
                if elapsed_secs > 0.0 {
                    (*bytes_transferred as f64) / elapsed_secs
                } else {
                    0.0
                }
            }
            TransferState::Completed { total_bytes } => {
                let elapsed_secs = self.elapsed().as_secs_f64();
                if elapsed_secs > 0.0 {
                    (*total_bytes as f64) / elapsed_secs
                } else {
                    0.0
                }
            }
            TransferState::Failed { .. } => 0.0,
        }
    }
}

/// Manager for partial message transfers
pub struct PartialTransferManager {
    transfers: Arc<Mutex<HashMap<TransferId, TransferInfo>>>,
    next_id: Arc<Mutex<u64>>,
    config: TransferConfig,
}

impl PartialTransferManager {
    /// Create a new transfer manager with default configuration
    pub fn new() -> Self {
        Self::with_config(TransferConfig::default())
    }

    /// Create a new transfer manager with custom configuration
    pub fn with_config(config: TransferConfig) -> Self {
        info!(
            chunk_size = config.chunk_size,
            allow_resume = config.allow_resume,
            timeout_secs = ?config.timeout_secs,
            "Creating partial transfer manager"
        );
        Self {
            transfers: Arc::new(Mutex::new(HashMap::new())),
            next_id: Arc::new(Mutex::new(1)),
            config,
        }
    }

    /// Start a new transfer session
    ///
    /// # Arguments
    /// * `total_bytes` - Total size of data to transfer
    ///
    /// # Returns
    /// Transfer ID for the new session
    pub async fn start_transfer(&self, total_bytes: usize) -> Result<TransferId> {
        let mut next_id = self.next_id.lock().await;
        let id = TransferId(*next_id);
        *next_id += 1;
        drop(next_id);

        info!(
            transfer_id = id.value(),
            total_bytes = total_bytes,
            chunk_size = self.config.chunk_size,
            "Starting new transfer"
        );

        let now = std::time::Instant::now();
        let info = TransferInfo {
            id,
            state: TransferState::InProgress {
                bytes_transferred: 0,
                total_bytes,
                chunk_index: 0,
            },
            config: self.config.clone(),
            started_at: now,
            updated_at: now,
        };

        self.transfers.lock().await.insert(id, info);
        Ok(id)
    }

    /// Update transfer progress
    ///
    /// # Arguments
    /// * `id` - Transfer ID
    /// * `bytes_transferred` - Total bytes transferred so far
    /// * `chunk_index` - Current chunk index
    pub async fn update_progress(
        &self,
        id: TransferId,
        bytes_transferred: usize,
        chunk_index: usize,
    ) -> Result<()> {
        let mut transfers = self.transfers.lock().await;

        let info = transfers.get_mut(&id).ok_or_else(|| {
            warn!(transfer_id = id.value(), "Transfer not found");
            IgtlError::Io(std::io::Error::new(
                std::io::ErrorKind::NotFound,
                "Transfer not found",
            ))
        })?;

        if let TransferState::InProgress { total_bytes, .. } = info.state {
            let progress = (bytes_transferred as f64 / total_bytes as f64) * 100.0;
            trace!(
                transfer_id = id.value(),
                bytes_transferred = bytes_transferred,
                total_bytes = total_bytes,
                chunk_index = chunk_index,
                progress_pct = format!("{:.1}%", progress),
                "Transfer progress updated"
            );
            info.state = TransferState::InProgress {
                bytes_transferred,
                total_bytes,
                chunk_index,
            };
            info.updated_at = std::time::Instant::now();
        } else {
            warn!(transfer_id = id.value(), "Transfer is not in progress");
            return Err(IgtlError::Io(std::io::Error::new(
                std::io::ErrorKind::InvalidInput,
                "Transfer is not in progress",
            )));
        }

        Ok(())
    }

    /// Mark transfer as completed
    pub async fn complete_transfer(&self, id: TransferId) -> Result<()> {
        let mut transfers = self.transfers.lock().await;

        let info = transfers.get_mut(&id).ok_or_else(|| {
            warn!(transfer_id = id.value(), "Transfer not found");
            IgtlError::Io(std::io::Error::new(
                std::io::ErrorKind::NotFound,
                "Transfer not found",
            ))
        })?;

        if let TransferState::InProgress { total_bytes, .. } = info.state {
            let elapsed = info.elapsed().as_secs_f64();
            let speed_mbps = if elapsed > 0.0 {
                (total_bytes as f64) / elapsed / 1_000_000.0
            } else {
                0.0
            };
            info!(
                transfer_id = id.value(),
                total_bytes = total_bytes,
                elapsed_secs = format!("{:.2}", elapsed),
                speed_mbps = format!("{:.2}", speed_mbps),
                "Transfer completed"
            );
            info.state = TransferState::Completed { total_bytes };
            info.updated_at = std::time::Instant::now();
        }

        Ok(())
    }

    /// Interrupt transfer (can be resumed if configured)
    pub async fn interrupt_transfer(&self, id: TransferId) -> Result<()> {
        let mut transfers = self.transfers.lock().await;

        let info = transfers.get_mut(&id).ok_or_else(|| {
            warn!(transfer_id = id.value(), "Transfer not found");
            IgtlError::Io(std::io::Error::new(
                std::io::ErrorKind::NotFound,
                "Transfer not found",
            ))
        })?;

        if let TransferState::InProgress {
            bytes_transferred,
            total_bytes,
            ..
        } = info.state
        {
            let resumable = info.config.allow_resume;
            warn!(
                transfer_id = id.value(),
                bytes_transferred = bytes_transferred,
                total_bytes = total_bytes,
                resumable = resumable,
                "Transfer interrupted"
            );
            info.state = TransferState::Interrupted {
                bytes_transferred,
                total_bytes,
                resumable,
            };
            info.updated_at = std::time::Instant::now();
        }

        Ok(())
    }

    /// Resume an interrupted transfer
    pub async fn resume_transfer(&self, id: TransferId) -> Result<usize> {
        let mut transfers = self.transfers.lock().await;

        let info = transfers.get_mut(&id).ok_or_else(|| {
            warn!(transfer_id = id.value(), "Transfer not found");
            IgtlError::Io(std::io::Error::new(
                std::io::ErrorKind::NotFound,
                "Transfer not found",
            ))
        })?;

        match info.state {
            TransferState::Interrupted {
                bytes_transferred,
                total_bytes,
                resumable: true,
            } => {
                let chunk_index = bytes_transferred / info.config.chunk_size;
                info!(
                    transfer_id = id.value(),
                    resuming_from = bytes_transferred,
                    total_bytes = total_bytes,
                    chunk_index = chunk_index,
                    "Resuming transfer"
                );
                info.state = TransferState::InProgress {
                    bytes_transferred,
                    total_bytes,
                    chunk_index,
                };
                info.updated_at = std::time::Instant::now();
                Ok(bytes_transferred)
            }
            TransferState::Interrupted {
                resumable: false, ..
            } => {
                warn!(transfer_id = id.value(), "Transfer is not resumable");
                Err(IgtlError::Io(std::io::Error::new(
                    std::io::ErrorKind::InvalidInput,
                    "Transfer is not resumable",
                )))
            }
            _ => {
                warn!(transfer_id = id.value(), "Transfer is not interrupted");
                Err(IgtlError::Io(std::io::Error::new(
                    std::io::ErrorKind::InvalidInput,
                    "Transfer is not interrupted",
                )))
            }
        }
    }

    /// Fail a transfer with error message
    pub async fn fail_transfer(&self, id: TransferId, error: String) -> Result<()> {
        let mut transfers = self.transfers.lock().await;

        if let Some(info) = transfers.get_mut(&id) {
            warn!(
                transfer_id = id.value(),
                error = %error,
                "Transfer failed"
            );
            info.state = TransferState::Failed { error };
            info.updated_at = std::time::Instant::now();
        }

        Ok(())
    }

    /// Get transfer information
    pub async fn get_transfer(&self, id: TransferId) -> Option<TransferInfo> {
        self.transfers.lock().await.get(&id).cloned()
    }

    /// Get all active transfers
    pub async fn active_transfers(&self) -> Vec<TransferInfo> {
        self.transfers
            .lock()
            .await
            .values()
            .filter(|info| matches!(info.state, TransferState::InProgress { .. }))
            .cloned()
            .collect()
    }

    /// Remove completed or failed transfers
    pub async fn cleanup_completed(&self) {
        self.transfers.lock().await.retain(|_, info| {
            !matches!(
                info.state,
                TransferState::Completed { .. } | TransferState::Failed { .. }
            )
        });
    }

    /// Remove transfers that have timed out
    pub async fn cleanup_timed_out(&self) {
        let config = &self.config;
        if let Some(timeout_secs) = config.timeout_secs {
            let timeout = std::time::Duration::from_secs(timeout_secs);
            let mut transfers = self.transfers.lock().await;
            let before_count = transfers.len();
            transfers.retain(|id, info| {
                let keep = info.idle_time() < timeout;
                if !keep {
                    debug!(
                        transfer_id = id.value(),
                        idle_time_secs = info.idle_time().as_secs(),
                        "Removing timed out transfer"
                    );
                }
                keep
            });
            let removed = before_count - transfers.len();
            if removed > 0 {
                info!(removed_count = removed, "Cleaned up timed out transfers");
            }
        }
    }
}

impl Default for PartialTransferManager {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[tokio::test]
    async fn test_start_transfer() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        assert!(matches!(info.state, TransferState::InProgress { .. }));
    }

    #[tokio::test]
    async fn test_update_progress() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        manager.update_progress(id, 500000, 5).await.unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        assert_eq!(info.state.progress(), 0.5);
    }

    #[tokio::test]
    async fn test_complete_transfer() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        manager.update_progress(id, 1000000, 10).await.unwrap();
        manager.complete_transfer(id).await.unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        assert!(info.state.is_complete());
        assert_eq!(info.state.progress(), 1.0);
    }

    #[tokio::test]
    async fn test_interrupt_and_resume() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        manager.update_progress(id, 500000, 5).await.unwrap();
        manager.interrupt_transfer(id).await.unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        assert!(info.state.is_resumable());

        let resumed_at = manager.resume_transfer(id).await.unwrap();
        assert_eq!(resumed_at, 500000);

        let info = manager.get_transfer(id).await.unwrap();
        assert!(matches!(info.state, TransferState::InProgress { .. }));
    }

    #[tokio::test]
    async fn test_fail_transfer() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        manager
            .fail_transfer(id, "Network error".to_string())
            .await
            .unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        assert!(matches!(info.state, TransferState::Failed { .. }));
    }

    #[tokio::test]
    async fn test_active_transfers() {
        let manager = PartialTransferManager::new();

        let id1 = manager.start_transfer(1000000).await.unwrap();
        let id2 = manager.start_transfer(2000000).await.unwrap();
        let id3 = manager.start_transfer(3000000).await.unwrap();

        manager.complete_transfer(id1).await.unwrap();
        manager.interrupt_transfer(id2).await.unwrap();

        let active = manager.active_transfers().await;
        assert_eq!(active.len(), 1);
        assert_eq!(active[0].id, id3);
    }

    #[tokio::test]
    async fn test_cleanup_completed() {
        let manager = PartialTransferManager::new();

        let id1 = manager.start_transfer(1000000).await.unwrap();
        let id2 = manager.start_transfer(2000000).await.unwrap();

        manager.complete_transfer(id1).await.unwrap();

        manager.cleanup_completed().await;

        assert!(manager.get_transfer(id1).await.is_none());
        assert!(manager.get_transfer(id2).await.is_some());
    }

    #[tokio::test]
    async fn test_transfer_speed() {
        let manager = PartialTransferManager::new();
        let id = manager.start_transfer(1000000).await.unwrap();

        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
        manager.update_progress(id, 500000, 5).await.unwrap();

        let info = manager.get_transfer(id).await.unwrap();
        let speed = info.speed_bps();

        // Should be around 5 MB/s (500000 bytes in ~0.1 sec)
        assert!(speed > 1_000_000.0); // At least 1 MB/s
    }
}