dfir_lang/graph/ops/
mod.rs

1//! DFIR's operators
2
3use std::collections::HashMap;
4use std::fmt::{Debug, Display};
5use std::ops::{Bound, RangeBounds};
6use std::sync::OnceLock;
7
8use documented::DocumentedVariants;
9use proc_macro2::{Ident, Literal, Span, TokenStream};
10use quote::quote_spanned;
11use serde::{Deserialize, Serialize};
12use slotmap::Key;
13use syn::punctuated::Punctuated;
14use syn::{Expr, Token, parse_quote_spanned};
15
16use super::{
17    GraphLoopId, GraphNode, GraphNodeId, GraphSubgraphId, OpInstGenerics, OperatorInstance,
18    PortIndexValue,
19};
20use crate::diagnostic::{Diagnostic, Diagnostics, Level};
21use crate::parse::{Operator, PortIndex};
22
23/// The delay (soft barrier) type, for each input to an operator if needed.
24#[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Debug)]
25pub enum DelayType {
26    /// Input must be collected over the preceding stratum.
27    Stratum,
28    /// Monotone accumulation: can delay to reduce flow rate, but also correct to emit "early"
29    MonotoneAccum,
30    /// Input must be collected over the previous tick.
31    Tick,
32    /// Input must be collected over the previous tick but also not cause a new tick to occur.
33    TickLazy,
34}
35
36/// Specification of the named (or unnamed) ports for an operator's inputs or outputs.
37pub enum PortListSpec {
38    /// Any number of unnamed (or optionally named) ports.
39    Variadic,
40    /// A specific number of named ports.
41    Fixed(Punctuated<PortIndex, Token![,]>),
42}
43
44/// An instance of this struct represents a single dfir operator.
45pub struct OperatorConstraints {
46    /// Operator's name.
47    pub name: &'static str,
48    /// Operator categories, for docs.
49    pub categories: &'static [OperatorCategory],
50
51    // TODO: generic argument ranges.
52    /// Input argument range required to not show an error.
53    pub hard_range_inn: &'static dyn RangeTrait<usize>,
54    /// Input argument range required to not show a warning.
55    pub soft_range_inn: &'static dyn RangeTrait<usize>,
56    /// Output argument range required to not show an error.
57    pub hard_range_out: &'static dyn RangeTrait<usize>,
58    /// Output argument range required to not show an warning.
59    pub soft_range_out: &'static dyn RangeTrait<usize>,
60    /// Number of arguments i.e. `operator(a, b, c)` has `num_args = 3`.
61    pub num_args: usize,
62    /// How many persistence lifetime arguments can be provided.
63    pub persistence_args: &'static dyn RangeTrait<usize>,
64    // /// How many (non-persistence) lifetime arguments can be provided.
65    // pub lifetime_args: &'static dyn RangeTrait<usize>,
66    /// How many generic type arguments can be provided.
67    pub type_args: &'static dyn RangeTrait<usize>,
68    /// If this operator receives external inputs and therefore must be in
69    /// stratum 0.
70    pub is_external_input: bool,
71    /// If this operator has a singleton reference output. For stateful operators.
72    /// If true, [`WriteContextArgs::singleton_output_ident`] will be set to a meaningful value in
73    /// the [`Self::write_fn`] invocation.
74    pub has_singleton_output: bool,
75    /// Flo semantics type.
76    pub flo_type: Option<FloType>,
77
78    /// What named or numbered input ports to expect?
79    pub ports_inn: Option<fn() -> PortListSpec>,
80    /// What named or numbered output ports to expect?
81    pub ports_out: Option<fn() -> PortListSpec>,
82
83    /// Determines if this input must be preceeded by a stratum barrier.
84    pub input_delaytype_fn: fn(&PortIndexValue) -> Option<DelayType>,
85    /// The operator's codegen. Returns code that is emited is several different locations. See [`OperatorWriteOutput`].
86    pub write_fn: WriteFn,
87}
88
89/// Type alias for [`OperatorConstraints::write_fn`]'s type.
90pub type WriteFn = fn(&WriteContextArgs<'_>, &mut Diagnostics) -> Result<OperatorWriteOutput, ()>;
91
92impl Debug for OperatorConstraints {
93    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
94        f.debug_struct("OperatorConstraints")
95            .field("name", &self.name)
96            .field("hard_range_inn", &self.hard_range_inn)
97            .field("soft_range_inn", &self.soft_range_inn)
98            .field("hard_range_out", &self.hard_range_out)
99            .field("soft_range_out", &self.soft_range_out)
100            .field("num_args", &self.num_args)
101            .field("persistence_args", &self.persistence_args)
102            .field("type_args", &self.type_args)
103            .field("is_external_input", &self.is_external_input)
104            .field("ports_inn", &self.ports_inn)
105            .field("ports_out", &self.ports_out)
106            // .field("input_delaytype_fn", &self.input_delaytype_fn)
107            // .field("flow_prop_fn", &self.flow_prop_fn)
108            // .field("write_fn", &self.write_fn)
109            .finish()
110    }
111}
112
113/// The code generated and returned by a [`OperatorConstraints::write_fn`].
114#[derive(Default)]
115#[non_exhaustive]
116pub struct OperatorWriteOutput {
117    /// Code which runs once outside any subgraphs, BEFORE subgraphs are initialized,
118    /// to set up any external state (state API, chanels, network connections, etc.)
119    /// to be used by the subgraph.
120    pub write_prologue: TokenStream,
121    /// Code which runs once outside the subgraph, AFTER subgraphs are initialized,
122    /// to set up state hooks which may need the subgraph ID.
123    pub write_prologue_after: TokenStream,
124    /// Iterator (or pusherator) code inside the subgraphs. The code for each
125    /// operator is emitted in order.
126    ///
127    /// Emitted code should assign to [`WriteContextArgs::ident`] and use
128    /// [`WriteContextArgs::inputs`] (pull `Stream`s) or
129    /// [`WriteContextArgs::outputs`] (push `Sink`s).
130    pub write_iterator: TokenStream,
131    /// Code which runs after `Stream`s/`Sink`s have been run. Mainly for flushing IO.
132    pub write_iterator_after: TokenStream,
133}
134
135/// Convenience range: zero or more (any number).
136pub const RANGE_ANY: &'static dyn RangeTrait<usize> = &(0..);
137/// Convenience range: exactly zero.
138pub const RANGE_0: &'static dyn RangeTrait<usize> = &(0..=0);
139/// Convenience range: exactly one.
140pub const RANGE_1: &'static dyn RangeTrait<usize> = &(1..=1);
141
142/// Helper to write the `write_iterator` portion of [`OperatorConstraints::write_fn`] output for
143/// unary identity operators.
144pub fn identity_write_iterator_fn(
145    &WriteContextArgs {
146        root,
147        op_span,
148        ident,
149        inputs,
150        outputs,
151        is_pull,
152        op_inst:
153            OperatorInstance {
154                generics: OpInstGenerics { type_args, .. },
155                ..
156            },
157        ..
158    }: &WriteContextArgs,
159) -> TokenStream {
160    let generic_type = type_args
161        .first()
162        .map(quote::ToTokens::to_token_stream)
163        .unwrap_or(quote_spanned!(op_span=> _));
164
165    if is_pull {
166        let input = &inputs[0];
167        quote_spanned! {op_span=>
168            let #ident = {
169                fn check_input<Pull, Item>(pull: Pull) -> impl #root::dfir_pipes::pull::Pull<Item = Item, Meta = Pull::Meta, CanPend = Pull::CanPend, CanEnd = Pull::CanEnd>
170                where
171                    Pull: #root::dfir_pipes::pull::Pull<Item = Item>,
172                {
173                    pull
174                }
175                check_input::<_, #generic_type>(#input)
176            };
177        }
178    } else {
179        let output = &outputs[0];
180        quote_spanned! {op_span=>
181            let #ident = {
182                fn check_output<Psh, Item>(push: Psh) -> impl #root::dfir_pipes::push::Push<Item, (), CanPend = Psh::CanPend>
183                where
184                    Psh: #root::dfir_pipes::push::Push<Item, ()>,
185                {
186                    push
187                }
188                check_output::<_, #generic_type>(#output)
189            };
190        }
191    }
192}
193
194/// [`OperatorConstraints::write_fn`] for unary identity operators.
195pub const IDENTITY_WRITE_FN: WriteFn = |write_context_args, _| {
196    let write_iterator = identity_write_iterator_fn(write_context_args);
197    Ok(OperatorWriteOutput {
198        write_iterator,
199        ..Default::default()
200    })
201};
202
203/// Helper to write the `write_iterator` portion of [`OperatorConstraints::write_fn`] output for
204/// the null operator - an operator that ignores all inputs and produces no output.
205pub fn null_write_iterator_fn(
206    &WriteContextArgs {
207        root,
208        op_span,
209        ident,
210        inputs,
211        outputs,
212        is_pull,
213        op_inst:
214            OperatorInstance {
215                generics: OpInstGenerics { type_args, .. },
216                ..
217            },
218        ..
219    }: &WriteContextArgs,
220) -> TokenStream {
221    let default_type = parse_quote_spanned! {op_span=> _};
222    let iter_type = type_args.first().unwrap_or(&default_type);
223
224    if is_pull {
225        quote_spanned! {op_span=>
226            let #ident = #root::dfir_pipes::pull::poll_fn({
227                #(
228                    let mut #inputs = ::std::boxed::Box::pin(#inputs);
229                )*
230                move |_cx| {
231                    // Make sure to poll all `#inputs` to completion.
232                    // NOTE(mingwei): `null()` can only have 0 or 1 inputs, though.
233                    // TODO(mingwei): Do we actually need to poll to completion or can we short-circuit?
234                    #(
235                        let #inputs = #root::dfir_pipes::pull::Pull::pull(
236                            ::std::pin::Pin::as_mut(&mut #inputs),
237                            <_ as #root::dfir_pipes::Context>::from_task(_cx),
238                        );
239                    )*
240                    #(
241                        if let #root::dfir_pipes::pull::PullStep::Pending(_) = #inputs {
242                            return #root::dfir_pipes::pull::PullStep::Pending(#root::dfir_pipes::Yes);
243                        }
244                    )*
245                    #root::dfir_pipes::pull::PullStep::<_, _, #root::dfir_pipes::Yes, _>::Ended(#root::dfir_pipes::Yes)
246                }
247            });
248        }
249    } else {
250        quote_spanned! {op_span=>
251            #[allow(clippy::let_unit_value)]
252            let _ = (#(#outputs),*);
253            let #ident = #root::dfir_pipes::push::for_each::<_, #iter_type>(::std::mem::drop::<#iter_type>);
254        }
255    }
256}
257
258/// [`OperatorConstraints::write_fn`] for the null operator - an operator that ignores all inputs
259/// and produces no output.
260pub const NULL_WRITE_FN: WriteFn = |write_context_args, _| {
261    let write_iterator = null_write_iterator_fn(write_context_args);
262    Ok(OperatorWriteOutput {
263        write_iterator,
264        ..Default::default()
265    })
266};
267
268macro_rules! declare_ops {
269    ( $( $mod:ident :: $op:ident, )* ) => {
270        $( pub(crate) mod $mod; )*
271        /// All DFIR operators.
272        pub const OPERATORS: &[OperatorConstraints] = &[
273            $( $mod :: $op, )*
274        ];
275    };
276}
277declare_ops![
278    all_iterations::ALL_ITERATIONS,
279    all_once::ALL_ONCE,
280    anti_join::ANTI_JOIN,
281    assert::ASSERT,
282    assert_eq::ASSERT_EQ,
283    batch::BATCH,
284    chain::CHAIN,
285    chain_first_n::CHAIN_FIRST_N,
286    _counter::_COUNTER,
287    cross_join::CROSS_JOIN,
288    cross_join_multiset::CROSS_JOIN_MULTISET,
289    cross_singleton::CROSS_SINGLETON,
290    demux_enum::DEMUX_ENUM,
291    dest_file::DEST_FILE,
292    dest_sink::DEST_SINK,
293    dest_sink_serde::DEST_SINK_SERDE,
294    difference::DIFFERENCE,
295    enumerate::ENUMERATE,
296    filter::FILTER,
297    filter_map::FILTER_MAP,
298    flat_map::FLAT_MAP,
299    flat_map_stream::FLAT_MAP_STREAM,
300    flatten::FLATTEN,
301    flatten_stream::FLATTEN_STREAM,
302    fold::FOLD,
303    fold_no_replay::FOLD_NO_REPLAY,
304    for_each::FOR_EACH,
305    identity::IDENTITY,
306    initialize::INITIALIZE,
307    inspect::INSPECT,
308    join::JOIN,
309    join_fused::JOIN_FUSED,
310    join_fused_lhs::JOIN_FUSED_LHS,
311    join_fused_rhs::JOIN_FUSED_RHS,
312    join_multiset::JOIN_MULTISET,
313    fold_keyed::FOLD_KEYED,
314    reduce_keyed::REDUCE_KEYED,
315    repeat_n::REPEAT_N,
316    // last_iteration::LAST_ITERATION,
317    lattice_bimorphism::LATTICE_BIMORPHISM,
318    _lattice_fold_batch::_LATTICE_FOLD_BATCH,
319    lattice_fold::LATTICE_FOLD,
320    _lattice_join_fused_join::_LATTICE_JOIN_FUSED_JOIN,
321    lattice_reduce::LATTICE_REDUCE,
322    map::MAP,
323    union::UNION,
324    multiset_delta::MULTISET_DELTA,
325    next_iteration::NEXT_ITERATION,
326    next_stratum::NEXT_STRATUM,
327    defer_signal::DEFER_SIGNAL,
328    defer_tick::DEFER_TICK,
329    defer_tick_lazy::DEFER_TICK_LAZY,
330    null::NULL,
331    partition::PARTITION,
332    persist::PERSIST,
333    persist_mut::PERSIST_MUT,
334    persist_mut_keyed::PERSIST_MUT_KEYED,
335    prefix::PREFIX,
336    resolve_futures::RESOLVE_FUTURES,
337    resolve_futures_blocking::RESOLVE_FUTURES_BLOCKING,
338    resolve_futures_blocking_ordered::RESOLVE_FUTURES_BLOCKING_ORDERED,
339    resolve_futures_ordered::RESOLVE_FUTURES_ORDERED,
340    reduce::REDUCE,
341    reduce_no_replay::REDUCE_NO_REPLAY,
342    scan::SCAN,
343    spin::SPIN,
344    sort::SORT,
345    sort_by_key::SORT_BY_KEY,
346    source_file::SOURCE_FILE,
347    source_interval::SOURCE_INTERVAL,
348    source_iter::SOURCE_ITER,
349    source_json::SOURCE_JSON,
350    source_stdin::SOURCE_STDIN,
351    source_stream::SOURCE_STREAM,
352    source_stream_serde::SOURCE_STREAM_SERDE,
353    state::STATE,
354    state_by::STATE_BY,
355    tee::TEE,
356    unique::UNIQUE,
357    unzip::UNZIP,
358    zip::ZIP,
359    zip_longest::ZIP_LONGEST,
360];
361
362/// Get the operator lookup table, generating it if needed.
363pub fn operator_lookup() -> &'static HashMap<&'static str, &'static OperatorConstraints> {
364    pub static OPERATOR_LOOKUP: OnceLock<HashMap<&'static str, &'static OperatorConstraints>> =
365        OnceLock::new();
366    OPERATOR_LOOKUP.get_or_init(|| OPERATORS.iter().map(|op| (op.name, op)).collect())
367}
368/// Find an operator by [`GraphNode`].
369pub fn find_node_op_constraints(node: &GraphNode) -> Option<&'static OperatorConstraints> {
370    if let GraphNode::Operator(operator) = node {
371        find_op_op_constraints(operator)
372    } else {
373        None
374    }
375}
376/// Find an operator by an AST [`Operator`].
377pub fn find_op_op_constraints(operator: &Operator) -> Option<&'static OperatorConstraints> {
378    let name = &*operator.name_string();
379    operator_lookup().get(name).copied()
380}
381
382/// Context arguments provided to [`OperatorConstraints::write_fn`].
383#[derive(Clone)]
384pub struct WriteContextArgs<'a> {
385    /// `dfir` crate name for `use #root::something`.
386    pub root: &'a TokenStream,
387    /// `context` ident, the name of the provided
388    /// [`dfir_rs::scheduled::Context`](https://hydro.run/rustdoc/dfir_rs/scheduled/context/struct.Context.html).
389    pub context: &'a Ident,
390    /// `df` ident, the name of the
391    /// [`dfir_rs::scheduled::graph::Dfir`](https://hydro.run/rustdoc/dfir_rs/scheduled/graph/struct.Dfir.html)
392    /// instance.
393    pub df_ident: &'a Ident,
394    /// Subgraph ID in which this operator is contained.
395    pub subgraph_id: GraphSubgraphId,
396    /// Node ID identifying this operator in the flat or partitioned graph meta-datastructure.
397    pub node_id: GraphNodeId,
398    /// Loop ID in which this operator is contained, or `None` if not in a loop.
399    pub loop_id: Option<GraphLoopId>,
400    /// The source span of this operator.
401    pub op_span: Span,
402    /// Tag for this operator appended to the generated identifier.
403    pub op_tag: Option<String>,
404    /// Identifier for a function to call when doing work outside the stream.
405    pub work_fn: &'a Ident,
406    /// Identifier for a function to wrap futures when doing work outside the stream.
407    pub work_fn_async: &'a Ident,
408
409    /// Ident the `Stream` or `Sink` should be assigned to.
410    pub ident: &'a Ident,
411    /// If a pull `Stream` (true) or push `Sink` (false) should be used.
412    pub is_pull: bool,
413    /// Input `Stream` operator idents (or ref idents; used for pull).
414    pub inputs: &'a [Ident],
415    /// Output `Sink` operator idents (or ref idents; used for push).
416    pub outputs: &'a [Ident],
417    /// Ident for the singleton output of this operator, if any.
418    pub singleton_output_ident: &'a Ident,
419
420    /// Operator name.
421    pub op_name: &'static str,
422    /// Operator instance arguments object.
423    pub op_inst: &'a OperatorInstance,
424    /// Arguments provided by the user into the operator as arguments.
425    /// I.e. the `a, b, c` in `-> my_op(a, b, c) -> `.
426    ///
427    /// These arguments include singleton postprocessing codegen, with
428    /// [`std::cell::RefCell::borrow_mut`] code pre-generated.
429    pub arguments: &'a Punctuated<Expr, Token![,]>,
430    /// Same as [`Self::arguments`] but with only `StateHandle`s, no borrowing code.
431    pub arguments_handles: &'a Punctuated<Expr, Token![,]>,
432}
433impl WriteContextArgs<'_> {
434    /// Generate a (almost certainly) unique identifier with the given suffix.
435    ///
436    /// Includes the subgraph and node IDs in the generated identifier.
437    ///
438    /// This will always return the same identifier for a given `suffix`.
439    pub fn make_ident(&self, suffix: impl AsRef<str>) -> Ident {
440        Ident::new(
441            &format!(
442                "sg_{:?}_node_{:?}_{}",
443                self.subgraph_id.data(),
444                self.node_id.data(),
445                suffix.as_ref(),
446            ),
447            self.op_span,
448        )
449    }
450
451    /// Returns `#root::scheduled::graph::StateLifespan::#variant` corresponding to the given
452    /// peristence.
453    pub fn persistence_as_state_lifespan(&self, persistence: Persistence) -> Option<TokenStream> {
454        let root = self.root;
455        let variant =
456            persistence.as_state_lifespan_variant(self.subgraph_id, self.loop_id, self.op_span)?;
457        Some(quote_spanned! {self.op_span=>
458            #root::scheduled::graph::StateLifespan::#variant
459        })
460    }
461
462    /// Returns the given number of persistence arguments, disallowing mutable lifetimes.
463    pub fn persistence_args_disallow_mutable<const N: usize>(
464        &self,
465        diagnostics: &mut Diagnostics,
466    ) -> [Persistence; N] {
467        let len = self.op_inst.generics.persistence_args.len();
468        if 0 != len && 1 != len && N != len {
469            diagnostics.push(Diagnostic::spanned(
470                self.op_span,
471                Level::Error,
472                format!(
473                    "The operator `{}` only accepts 0, 1, or {} persistence arguments",
474                    self.op_name, N
475                ),
476            ));
477        }
478
479        let default_persistence = if self.loop_id.is_some() {
480            Persistence::None
481        } else {
482            Persistence::Tick
483        };
484        let mut out = [default_persistence; N];
485        self.op_inst
486            .generics
487            .persistence_args
488            .iter()
489            .copied()
490            .cycle() // Re-use the first element for both persistences.
491            .take(N)
492            .enumerate()
493            .filter(|&(_i, p)| {
494                if p == Persistence::Mutable {
495                    diagnostics.push(Diagnostic::spanned(
496                        self.op_span,
497                        Level::Error,
498                        format!(
499                            "An implementation of `'{}` does not exist",
500                            p.to_str_lowercase()
501                        ),
502                    ));
503                    false
504                } else {
505                    true
506                }
507            })
508            .for_each(|(i, p)| {
509                out[i] = p;
510            });
511        out
512    }
513}
514
515/// An object-safe version of [`RangeBounds`].
516pub trait RangeTrait<T>: Send + Sync + Debug
517where
518    T: ?Sized,
519{
520    /// Start (lower) bound.
521    fn start_bound(&self) -> Bound<&T>;
522    /// End (upper) bound.
523    fn end_bound(&self) -> Bound<&T>;
524    /// Returns if `item` is contained in this range.
525    fn contains(&self, item: &T) -> bool
526    where
527        T: PartialOrd<T>;
528
529    /// Turn this range into a human-readable string.
530    fn human_string(&self) -> String
531    where
532        T: Display + PartialEq,
533    {
534        match (self.start_bound(), self.end_bound()) {
535            (Bound::Unbounded, Bound::Unbounded) => "any number of".to_owned(),
536
537            (Bound::Included(n), Bound::Included(x)) if n == x => {
538                format!("exactly {}", n)
539            }
540            (Bound::Included(n), Bound::Included(x)) => {
541                format!("at least {} and at most {}", n, x)
542            }
543            (Bound::Included(n), Bound::Excluded(x)) => {
544                format!("at least {} and less than {}", n, x)
545            }
546            (Bound::Included(n), Bound::Unbounded) => format!("at least {}", n),
547            (Bound::Excluded(n), Bound::Included(x)) => {
548                format!("more than {} and at most {}", n, x)
549            }
550            (Bound::Excluded(n), Bound::Excluded(x)) => {
551                format!("more than {} and less than {}", n, x)
552            }
553            (Bound::Excluded(n), Bound::Unbounded) => format!("more than {}", n),
554            (Bound::Unbounded, Bound::Included(x)) => format!("at most {}", x),
555            (Bound::Unbounded, Bound::Excluded(x)) => format!("less than {}", x),
556        }
557    }
558}
559
560impl<R, T> RangeTrait<T> for R
561where
562    R: RangeBounds<T> + Send + Sync + Debug,
563{
564    fn start_bound(&self) -> Bound<&T> {
565        self.start_bound()
566    }
567
568    fn end_bound(&self) -> Bound<&T> {
569        self.end_bound()
570    }
571
572    fn contains(&self, item: &T) -> bool
573    where
574        T: PartialOrd<T>,
575    {
576        self.contains(item)
577    }
578}
579
580/// Persistence lifetimes: `'none`, `'tick`, `'static`, or `'mutable`.
581#[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Debug, Serialize, Deserialize)]
582pub enum Persistence {
583    /// No persistence, for within a loop iteration.
584    None,
585    /// Persistence throughout a single loop execution, across iterations.
586    Loop,
587    /// Persistence for one tick, at the top-level only (outside any loops).
588    Tick,
589    /// Persistence across all ticks.
590    Static,
591    /// The static lifetime but allowing non-monotonic mutability.
592    Mutable,
593}
594impl Persistence {
595    /// Returns just the variant of `#root::scheduled::graph::StateLifespan::VARIANT` for use in macros.
596    pub fn as_state_lifespan_variant(
597        self,
598        subgraph_id: GraphSubgraphId,
599        loop_id: Option<GraphLoopId>,
600        span: Span,
601    ) -> Option<TokenStream> {
602        match self {
603            Persistence::None => {
604                let sg_ident = subgraph_id.as_ident(span);
605                Some(quote_spanned!(span=> Subgraph(#sg_ident)))
606            }
607            Persistence::Loop => {
608                let loop_ident = loop_id
609                    .expect("`Persistence::Loop` outside of a loop context.")
610                    .as_ident(span);
611                Some(quote_spanned!(span=> Loop(#loop_ident)))
612            }
613            Persistence::Tick => Some(quote_spanned!(span=> Tick)),
614            Persistence::Static => None,
615            Persistence::Mutable => None,
616        }
617    }
618
619    /// Returns a lowercase string for the persistence type.
620    pub fn to_str_lowercase(self) -> &'static str {
621        match self {
622            Persistence::None => "none",
623            Persistence::Tick => "tick",
624            Persistence::Loop => "loop",
625            Persistence::Static => "static",
626            Persistence::Mutable => "mutable",
627        }
628    }
629}
630
631/// Helper which creates a error message string literal for when the Tokio runtime is not found.
632fn make_missing_runtime_msg(op_name: &str) -> Literal {
633    Literal::string(&format!(
634        "`{}()` must be used within a Tokio runtime. For example, use `#[dfir_rs::main]` on your main method.",
635        op_name
636    ))
637}
638
639/// Operator categories, for docs.
640#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, DocumentedVariants)]
641pub enum OperatorCategory {
642    /// Maps: Simple one-in-one-out operators.
643    Map,
644    /// Filters: One-in zero-or-one-out operators.
645    Filter,
646    /// Flattens: One-in multiple-out operators.
647    Flatten,
648    /// Folds: Operators which accumulate elements together.
649    Fold,
650    /// Keyed Folds: Operators which accumulate elements together by key.
651    KeyedFold,
652    /// Lattice Folds: Folds based on lattice-merge.
653    LatticeFold,
654    /// Persistent Operators: Persistent (stateful) operators.
655    Persistence,
656    /// Multi-Input Operators: Operators with multiple inputs.
657    MultiIn,
658    /// Multi-Output Operators: Operators with multiple outputs.
659    MultiOut,
660    /// Sources: Operators which produce output elements (and consume no inputs).
661    Source,
662    /// Sinks: Operators which consume input elements (and produce no outputs).
663    Sink,
664    /// Control Flow Operators: Operators which affect control flow/scheduling.
665    Control,
666    /// Compiler Fusion Operators: Operators which are necessary to implement certain optimizations and rewrite rules.
667    CompilerFusionOperator,
668    /// Windowing Operators: Operators for windowing `loop` inputs.
669    Windowing,
670    /// Un-Windowing Operators: Operators for collecting `loop` outputs.
671    Unwindowing,
672}
673impl OperatorCategory {
674    /// Human-readible heading name, for docs.
675    pub fn name(self) -> &'static str {
676        self.get_variant_docs().split_once(":").unwrap().0
677    }
678    /// Human description, for docs.
679    pub fn description(self) -> &'static str {
680        self.get_variant_docs().split_once(":").unwrap().1
681    }
682}
683
684/// Operator type for Flo semantics.
685#[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Debug)]
686pub enum FloType {
687    /// A source operator, which must be at the top level.
688    Source,
689    /// A windowing operator, for moving data into a loop context.
690    Windowing,
691    /// An un-windowing operator, for moving data out of a loop context.
692    Unwindowing,
693    /// Moves data into the next loop iteration within a loop context.
694    NextIteration,
695}
dfir_lang/graph/ops/mod.rs

dfir_lang/graph/ops/
mod.rs
