flute 1.11.0

File Delivery over Unidirectional Transport (FLUTE)
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

use pyo3::{exceptions::PyTypeError, prelude::*};

#[pyclass]
#[derive(Debug)]
pub struct Oti(pub crate::core::Oti);

#[pymethods]
impl Oti {
    #[new]
    pub fn new() -> Self {
        Self {
            0: Default::default(),
        }
    }

    #[staticmethod]
    fn new_no_code(
        encoding_symbol_length: u16,
        maximum_source_block_length: u16,
    ) -> PyResult<Self> {
        Ok(Self {
            0: crate::core::Oti::new_no_code(encoding_symbol_length, maximum_source_block_length),
        })
    }

    #[staticmethod]
    fn new_reed_solomon_rs28(
        encoding_symbol_length: u16,
        maximum_source_block_length: u8,
        max_number_of_parity_symbols: u8,
    ) -> PyResult<Self> {
        let oti = crate::core::Oti::new_reed_solomon_rs28(
            encoding_symbol_length,
            maximum_source_block_length,
            max_number_of_parity_symbols,
        )
        .map_err(|e| PyTypeError::new_err(e.0.to_string()))?;
        Ok(Self { 0: oti })
    }

    #[staticmethod]
    fn new_reed_solomon_rs28_under_specified(
        encoding_symbol_length: u16,
        maximum_source_block_length: u16,
        max_number_of_parity_symbols: u16,
    ) -> PyResult<Self> {
        let oti = crate::core::Oti::new_reed_solomon_rs28_under_specified(
            encoding_symbol_length,
            maximum_source_block_length,
            max_number_of_parity_symbols,
        )
        .map_err(|e| PyTypeError::new_err(e.0.to_string()))?;
        Ok(Self { 0: oti })
    }

    #[getter]
    fn get_max_transfer_length(&self) -> PyResult<usize> {
        Ok(self.0.max_transfer_length())
    }

    #[getter]
    fn get_fec_encoding_id(&self) -> PyResult<u8> {
        Ok(self.0.fec_encoding_id as u8)
    }

    #[setter]
    fn set_fec_encoding_id(&mut self, value: u8) -> PyResult<()> {
        let encoding_id: crate::core::FECEncodingID = value
            .try_into()
            .map_err(|_| PyTypeError::new_err("Invalid FEC Encoding ID"))?;
        self.0.fec_encoding_id = encoding_id;
        Ok(())
    }

    #[getter]
    fn get_fec_instance_id(&self) -> PyResult<u16> {
        Ok(self.0.fec_instance_id)
    }

    #[setter]
    fn set_fec_instance_id(&mut self, value: u16) -> PyResult<()> {
        self.0.fec_instance_id = value;
        Ok(())
    }

    #[getter]
    fn get_maximum_source_block_length(&self) -> PyResult<u32> {
        Ok(self.0.maximum_source_block_length)
    }

    #[setter]
    fn set_maximum_source_block_length(&mut self, value: u32) -> PyResult<()> {
        self.0.maximum_source_block_length = value;
        Ok(())
    }

    #[getter]
    fn get_encoding_symbol_length(&self) -> PyResult<u16> {
        Ok(self.0.encoding_symbol_length)
    }

    #[setter]
    fn set_encoding_symbol_length(&mut self, value: u16) -> PyResult<()> {
        self.0.encoding_symbol_length = value;
        Ok(())
    }

    #[getter]
    fn get_max_number_of_parity_symbols(&self) -> PyResult<u16> {
        Ok(self.0.encoding_symbol_length)
    }

    #[setter]
    fn set_max_number_of_parity_symbols(&mut self, value: u32) -> PyResult<()> {
        self.0.max_number_of_parity_symbols = value;
        Ok(())
    }

    #[getter]
    fn get_inband_fti(&self) -> PyResult<bool> {
        Ok(self.0.inband_fti)
    }

    #[setter]
    fn set_inband_fti(&mut self, value: bool) -> PyResult<()> {
        self.0.inband_fti = value;
        Ok(())
    }

    // TODO
    // reed_solomon_scheme_specific
    // raptorq_scheme_specific
}