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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use std::sync::Arc;

use crate::prelude::*;
use thirdparty::arrow_array::Array;

/// Typed Query to query data from the dataflow
pub struct Query<T: ArrowMessage, F: ArrowMessage> {
    pub raw: RawQuery,

    _phantom: std::marker::PhantomData<(T, F)>,
}

impl<T: ArrowMessage, F: ArrowMessage> Query<T, F> {
    /// Create a new typed Query
    pub fn new(
        tx: MessageSender,
        rx: MessageReceiver,
        clock: Arc<HLC>,
        source: NodeLayout,
        layout: QueryLayout,
    ) -> Self {
        Self {
            raw: RawQuery::new(tx, rx, clock, source, layout),
            _phantom: std::marker::PhantomData,
        }
    }

    /// Query 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_query(&mut self, data: T) -> Result<(Header, F)> {
        let (header, data) = self.raw.blocking_query(
            data.try_into_arrow()
                .wrap_err(report_failed_conversion_to_arrow::<T>(
                    &self.raw.source,
                    &self.raw.layout,
                ))?
                .into_data(),
        )?;

        Ok((
            header,
            F::try_from_arrow(data).wrap_err(report_failed_conversion_from_arrow::<F>(
                &self.raw.source,
                &self.raw.layout,
            ))?,
        ))
    }

    /// Query a message from the channel and converting it from Arrow format, asynchronously
    pub async fn query(&mut self, data: T) -> Result<(Header, F)> {
        let (header, data) = self
            .raw
            .query(
                data.try_into_arrow()
                    .wrap_err(report_failed_conversion_to_arrow::<T>(
                        &self.raw.source,
                        &self.raw.layout,
                    ))?
                    .into_data(),
            )
            .await?;

        Ok((
            header,
            F::try_from_arrow(data).wrap_err(report_failed_conversion_from_arrow::<F>(
                &self.raw.source,
                &self.raw.layout,
            ))?,
        ))
    }
}