citadel_sdk/prefabs/server/
accept_file_transfer_kernel.rs

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
//! Automatic File Transfer Acceptance
//!
//! This module provides a simple network kernel that automatically accepts and processes
//! all incoming file transfers. It's useful for server-side implementations that need
//! to handle file uploads without custom processing.
//!
//! # Features
//! - Automatic file transfer acceptance
//! - Silent processing of transfers
//! - Zero configuration required
//! - Minimal resource usage
//! - Error handling for transfers
//!
//! # Example:
//! ```rust
//! use citadel_sdk::prelude::*;
//! use citadel_sdk::prefabs::server::accept_file_transfer_kernel::AcceptFileTransferKernel;
//!
//! # fn main() -> Result<(), NetworkError> {
//! let kernel = Box::new(AcceptFileTransferKernel::<StackedRatchet>::default());
//! # Ok(())
//! # }
//! ```
//!
//! # Important Notes
//! - All file transfers are automatically accepted
//! - No customization of transfer handling
//! - Transfers are processed silently
//! - Errors are logged but not propagated
//!
//! # Related Components
//! - [`NetKernel`]: Base trait for network kernels
//! - [`ObjectTransferHandler`]: File transfer processing
//! - [`NodeResult`]: Network event handling
//!
//! [`NetKernel`]: crate::prelude::NetKernel
//! [`ObjectTransferHandler`]: crate::prelude::ObjectTransferHandler
//! [`NodeResult`]: crate::prelude::NodeResult

use crate::prelude::*;
use std::marker::PhantomData;

pub struct AcceptFileTransferKernel<R: Ratchet>(PhantomData<R>);

impl<R: Ratchet> Default for AcceptFileTransferKernel<R> {
    fn default() -> Self {
        Self(Default::default())
    }
}

#[async_trait]
impl<R: Ratchet> NetKernel<R> for AcceptFileTransferKernel<R> {
    fn load_remote(&mut self, _node_remote: NodeRemote<R>) -> Result<(), NetworkError> {
        Ok(())
    }

    async fn on_start(&self) -> Result<(), NetworkError> {
        Ok(())
    }

    async fn on_node_event_received(&self, message: NodeResult<R>) -> Result<(), NetworkError> {
        if let NodeResult::ObjectTransferHandle(mut handle) = message {
            let _ = handle
                .handle
                .exhaust_stream()
                .await
                .map_err(|err| NetworkError::Generic(err.into_string()))?;
        }

        Ok(())
    }

    async fn on_stop(&mut self) -> Result<(), NetworkError> {
        Ok(())
    }
}