flarrow-api 0.3.1

flarrow (flow + arrow) is a rust runtime/framework for building dataflow applications.
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

use crate::prelude::*;

/// Typed Input to receive data from the dataflow
#[derive(Debug)]
pub struct Input<T: ArrowMessage> {
    pub raw: RawInput,
    _phantom: std::marker::PhantomData<T>,
}

impl<T: ArrowMessage> Input<T> {
    /// Create a new typed Input from a MessageReceiver, NodeLayout, and InputLayout
    pub fn new(rx: MessageReceiver, source: NodeLayout, layout: InputLayout) -> Self {
        Self {
            raw: RawInput::new(rx, source, layout),
            _phantom: std::marker::PhantomData,
        }
    }

    /// Receive a message from the channel and converting it from Arrow format, blocking until one is available, don't use it
    /// in async context
    pub fn blocking_recv(&mut self) -> Result<(Header, T)> {
        let (header, data) = self
            .raw
            .blocking_recv()
            .wrap_err(report_error_receiving(&self.raw.source, &self.raw.layout))?;

        let message = T::try_from_arrow(data).wrap_err(
            report_failed_conversion_from_arrow::<T>(&self.raw.source, &self.raw.layout),
        )?;

        Ok((header, message))
    }

    /// Receive a message from the channel and converting it from Arrow format, asyncronously
    pub async fn recv(&mut self) -> Result<(Header, T)> {
        let (header, data) = self
            .raw
            .recv()
            .await
            .wrap_err(report_error_receiving(&self.raw.source, &self.raw.layout))?;

        let message = T::try_from_arrow(data).wrap_err(
            report_failed_conversion_from_arrow::<T>(&self.raw.source, &self.raw.layout),
        )?;

        Ok((header, message))
    }
}