protoflow_blocks/blocks/io/
decode.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
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
// This is free and unencumbered software released into the public domain.

extern crate std;

use crate::{
    prelude::{vec, Bytes, FromStr, String, ToString, Vec},
    types::Encoding,
    StdioConfig, StdioError, StdioSystem, System,
};
use protoflow_core::{
    Block, BlockError, BlockResult, BlockRuntime, InputPort, Message, OutputPort,
};
use protoflow_derive::Block;
use simple_mermaid::mermaid;
use std::io::BufRead;

/// A block that decodes `T` messages from a byte stream.
///
/// # Block Diagram
#[doc = mermaid!("../../../doc/io/decode.mmd")]
///
/// # Sequence Diagram
#[doc = mermaid!("../../../doc/io/decode.seq.mmd" framed)]
///
/// # Examples
///
/// ## Using the block in a system
///
/// ```rust
/// # use protoflow_blocks::*;
/// # fn main() {
/// System::build(|s| {
///     let stdin = s.read_stdin();
///     let message_decoder = s.decode_lines();
///     let counter = s.count::<String>();
///     let count_encoder = s.encode_lines();
///     let stdout = s.write_stdout();
///     s.connect(&stdin.output, &message_decoder.input);
///     s.connect(&message_decoder.output, &counter.input);
///     s.connect(&counter.count, &count_encoder.input);
///     s.connect(&count_encoder.output, &stdout.input);
/// });
/// # }
/// ```
///
/// ## Running the block via the CLI
///
/// ```console
/// $ protoflow execute Decode encoding=text
/// ```
///
/// ```console
/// $ protoflow execute Decode encoding=protobuf
/// ```
///
#[derive(Block, Clone)]
pub struct Decode<T: Message + FromStr = String> {
    /// The input byte stream.
    #[input]
    pub input: InputPort<Bytes>,

    /// The output message stream.
    #[output]
    pub output: OutputPort<T>,

    /// A configuration parameter for how to decode messages.
    #[parameter]
    pub encoding: Encoding,
}

impl<T: Message + FromStr> Decode<T> {
    pub fn new(input: InputPort<Bytes>, output: OutputPort<T>) -> Self {
        Self::with_params(input, output, None)
    }

    pub fn with_params(
        input: InputPort<Bytes>,
        output: OutputPort<T>,
        encoding: Option<Encoding>,
    ) -> Self {
        Self {
            input,
            output,
            encoding: encoding.unwrap_or_default(),
        }
    }
}

impl<T: Message + FromStr + 'static> Decode<T> {
    pub fn with_system(system: &System, encoding: Option<Encoding>) -> Self {
        use crate::SystemBuilding;
        Self::with_params(system.input(), system.output(), encoding)
    }
}

impl<T: Message + FromStr> Block for Decode<T> {
    fn execute(&mut self, _runtime: &dyn BlockRuntime) -> BlockResult {
        let mut buffer = Vec::<u8>::new();

        while let Some(chunk) = self.input.recv()? {
            buffer.extend_from_slice(&chunk);

            let mut cursor = std::io::Cursor::new(&buffer);

            let _message = match self.encoding {
                Encoding::ProtobufWithLengthPrefix => todo!(), // TODO
                Encoding::ProtobufWithoutLengthPrefix => todo!(), // TODO
                Encoding::TextWithNewlineSuffix => {
                    if !chunk.contains(&b'\n') {
                        continue; // skip useless chunks
                    }
                    let mut line = String::new();
                    while cursor.read_line(&mut line)? > 0 {
                        if !line.ends_with('\n') {
                            cursor.set_position(cursor.position() - line.len() as u64);
                            break;
                        }
                        let stripped_line =
                            line.strip_suffix('\n').expect("line ends with newline");
                        match T::from_str(stripped_line) {
                            Ok(message) => self.output.send(&message)?,
                            Err(_error) => {
                                BlockError::Other("decode error".to_string()); // FIXME
                            }
                        }
                        line.clear();
                    }
                }
            };

            buffer.drain(..cursor.position() as usize);
        }

        self.input.close()?;
        Ok(())
    }
}

#[cfg(feature = "std")]
impl StdioSystem for Decode {
    fn build_system(config: StdioConfig) -> Result<System, StdioError> {
        //use crate::{CoreBlocks, SysBlocks, SystemBuilding};

        config.allow_only(vec!["encoding"])?;

        Ok(System::build(|_s| todo!()))
    }
}

#[cfg(test)]
mod tests {
    use super::Decode;
    use crate::{System, SystemBuilding};

    #[test]
    fn instantiate_block() {
        // Check that the block is constructible:
        let _ = System::build(|s| {
            let _ = s.block(Decode::<i32>::new(s.input(), s.output()));
        });
    }
}