Struct rtlola_hir::hir::RtLolaHir
source · pub struct RtLolaHir<M: HirMode> { /* private fields */ }
Expand description
This struct constitutes the Mid-Level Intermediate Representation (MIR) of an RTLola specification.
The RtLolaHir is specifically designed to allow for convenient manipulation and analysis. Hence, it is perfect for working on the specification rather than work with it.
Most Notable Structs and Enums
- RtLolaMir is the root data structure representing the specification.
- Output represents a single output stream. The data structure is enriched with information regarding streams accessing it or accessed by it and much more. For input streams confer Input.
- StreamReference used for referencing streams within the Mir.
- Expression represents an expression. It contains its ExpressionKind and its type. The latter contains all information specific to a certain kind of expression such as sub-expressions of operators.
Type-State
The Hir follows a type-state pattern. To this end, it has a type parameter, its HirMode. The Hir starts in the BaseMode and progresses through different stages until reaching CompleteMode.
Each stage constitutes another level of refinement and adds functionality. The functionality can be accesses by importing the respective trait and requiring the mode of the Hir to implement the trait.
The following traits exist.
- DepAnaTrait provides access to a dependency graph (see petgraph) and functions to access immediate neighbors of streams. Obtained via determine_evaluation_order.
- TypedTrait provides type information. Obtained via check_types.
- OrderedTrait provides information regarding the evaluation order of streams. Obtained via determine_evaluation_order.
- MemBoundTrait provides information on how many values of a stream have to be kept in memory at the same time. Obtained via determine_memory_bounds.
Progression through different stages is managed by the HirStage trait, in particular HirStage::progress.
See Also
- rtlola_frontend for an overview regarding different representations.
- from_ast / fully_analyzed to obtain an RtLolaHir for a specification in form of an Ast.
- RtLolaHir for a data structs designed for working _on_it.
- RtLolaAst, which is the most basic and down-to-syntax data structure available for RTLola.
Implementations§
source§impl<M: HirMode + TypedTrait> RtLolaHir<M>
impl<M: HirMode + TypedTrait> RtLolaHir<M>
sourcepub fn select(&self) -> StreamSelector<'_, M, All>
pub fn select(&self) -> StreamSelector<'_, M, All>
Creates a StreamSelector to query the HIR for different classes of output streams.
source§impl<M: HirMode> RtLolaHir<M>
impl<M: HirMode> RtLolaHir<M>
sourcepub fn inputs(&self) -> impl Iterator<Item = &Input>
pub fn inputs(&self) -> impl Iterator<Item = &Input>
Provides access to an iterator over all input streams.
sourcepub fn outputs(&self) -> impl Iterator<Item = &Output>
pub fn outputs(&self) -> impl Iterator<Item = &Output>
Provides access to an iterator over all output streams.
sourcepub fn triggers(&self) -> impl Iterator<Item = &Trigger>
pub fn triggers(&self) -> impl Iterator<Item = &Trigger>
Provides access to an iterator over all triggers.
sourcepub fn num_inputs(&self) -> usize
pub fn num_inputs(&self) -> usize
Yields the number of input streams present in the Hir. Not necessarily equal to the number of input streams in the specification.
sourcepub fn num_outputs(&self) -> usize
pub fn num_outputs(&self) -> usize
Yields the number of output streams present in the Hir. Not necessarily equal to the number of output streams in the specification.
sourcepub fn num_triggers(&self) -> usize
pub fn num_triggers(&self) -> usize
Yields the number of triggers present in the Hir. Not necessarily equal to the number of triggers in the specification.
sourcepub fn all_streams(&self) -> impl Iterator<Item = StreamReference> + '_
pub fn all_streams(&self) -> impl Iterator<Item = StreamReference> + '_
Provides access to an iterator over all streams, i.e., inputs, outputs, and triggers.
sourcepub fn get_input_with_name(&self, name: &str) -> Option<&Input>
pub fn get_input_with_name(&self, name: &str) -> Option<&Input>
Retrieves an input stream based on its name. Fails if no such input stream exists.
sourcepub fn get_output_with_name(&self, name: &str) -> Option<&Output>
pub fn get_output_with_name(&self, name: &str) -> Option<&Output>
Retrieves an output stream based on its name. Fails if no such output stream exists.
sourcepub fn output(&self, sref: StreamReference) -> Option<&Output>
pub fn output(&self, sref: StreamReference) -> Option<&Output>
Retrieves an output stream based on a stream reference. Fails if no such stream exists or sref
is a StreamReference::In.
sourcepub fn input(&self, sref: StreamReference) -> Option<&Input>
pub fn input(&self, sref: StreamReference) -> Option<&Input>
Retrieves an input stream based on a stream reference. Fails if no such stream exists or sref
is a StreamReference::Out.
sourcepub fn window_refs(&self) -> Vec<WindowReference> ⓘ
pub fn window_refs(&self) -> Vec<WindowReference> ⓘ
Provides access to a collection of references for all windows occurring in the Hir.
sourcepub fn sliding_windows(&self) -> Vec<&Window<SlidingAggr>> ⓘ
pub fn sliding_windows(&self) -> Vec<&Window<SlidingAggr>> ⓘ
Provides access to a collection of references for all sliding windows occurring in the Hir.
sourcepub fn discrete_windows(&self) -> Vec<&Window<DiscreteAggr>> ⓘ
pub fn discrete_windows(&self) -> Vec<&Window<DiscreteAggr>> ⓘ
Provides access to a collection of references for all discrete windows occurring in the Hir.
sourcepub fn expression(&self, id: ExprId) -> &Expression
pub fn expression(&self, id: ExprId) -> &Expression
sourcepub fn func_declaration(&self, func_name: &str) -> &FuncDecl
pub fn func_declaration(&self, func_name: &str) -> &FuncDecl
Retrieves a function declaration for a given function name.
Panic
Panics if the declaration does not exist.
sourcepub fn single_sliding(&self, window: WindowReference) -> Window<SlidingAggr>
pub fn single_sliding(&self, window: WindowReference) -> Window<SlidingAggr>
sourcepub fn single_discrete(&self, window: WindowReference) -> Window<DiscreteAggr>
pub fn single_discrete(&self, window: WindowReference) -> Window<DiscreteAggr>
sourcepub fn spawn(&self, sr: StreamReference) -> Option<SpawnDef<'_>>
pub fn spawn(&self, sr: StreamReference) -> Option<SpawnDef<'_>>
Retrieves the spawn definition of a particular output stream or trigger or None
for input references.
sourcepub fn spawn_cond(&self, sr: StreamReference) -> Option<&Expression>
pub fn spawn_cond(&self, sr: StreamReference) -> Option<&Expression>
Retrieves the spawn condition of a particular output stream or None
for input and trigger references.
If all parts of the SpawnDef are needed, see RtLolaHir::spawn
sourcepub fn spawn_expr(&self, sr: StreamReference) -> Option<&Expression>
pub fn spawn_expr(&self, sr: StreamReference) -> Option<&Expression>
Retrieves the spawn expresion of a particular output stream or None
for input and trigger references.
If all parts of the SpawnDef are needed, see RtLolaHir::spawn
sourcepub fn spawn_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
pub fn spawn_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
Retrieves the spawn pacing of a particular output stream or None
for input and trigger references.
If all parts of the SpawnDef are needed, see RtLolaHir::spawn
sourcepub fn eval(&self, sr: StreamReference) -> Option<EvalDef<'_>>
pub fn eval(&self, sr: StreamReference) -> Option<EvalDef<'_>>
Retrieves the eval definition of a particular output stream or trigger or None
for input references.
sourcepub fn eval_cond(&self, sr: StreamReference) -> Option<&Expression>
pub fn eval_cond(&self, sr: StreamReference) -> Option<&Expression>
Retrieves the eval condition of a particular output stream or None
for input and trigger references.
If all parts of the EvalDef are needed, see RtLolaHir::eval
sourcepub fn eval_expr(&self, sr: StreamReference) -> Option<&Expression>
pub fn eval_expr(&self, sr: StreamReference) -> Option<&Expression>
Retrieves the eval expression of a particular output stream or trigger and None
for input references.
If all parts of the EvalDef are needed, see RtLolaHir::eval
sourcepub fn eval_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
pub fn eval_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
Retrieves the eval pacing of a particular output stream or trigger None
for input references.
If all parts of the EvalDef are needed, see RtLolaHir::eval
sourcepub fn close(&self, sr: StreamReference) -> Option<CloseDef<'_>>
pub fn close(&self, sr: StreamReference) -> Option<CloseDef<'_>>
Retrieves the expressions representing the close definition of a particular output stream or None
for input and trigger references.
sourcepub fn close_cond(&self, sr: StreamReference) -> Option<&Expression>
pub fn close_cond(&self, sr: StreamReference) -> Option<&Expression>
Retrieves the expression representing the close condition of a particular output stream or None
for input and trigger references.
If all parts of the CloseDef are needed, see RtLolaHir::close
sourcepub fn close_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
pub fn close_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>
Retrieves the close pacing of a particular output stream or None
for input and trigger references.
If all parts of the CloseDef are needed, see RtLolaHir::close
sourcepub fn names(&self) -> HashMap<StreamReference, &str>
pub fn names(&self) -> HashMap<StreamReference, &str>
Generates a map from a StreamReference to the name of the corresponding stream.
source§impl RtLolaHir<BaseMode>
impl RtLolaHir<BaseMode>
sourcepub fn check_types(self) -> Result<RtLolaHir<TypedMode>, RtLolaError>
pub fn check_types(self) -> Result<RtLolaHir<TypedMode>, RtLolaError>
Returns the RtLolaHir with the type information for each stream and expression
The function returns the RtLolaHir after the type analysis. The new mode implements the same functionality as the BaseMode and additionally holds for each stream and expression its StreamType. The function moves the information of the previous mode to the new one and therefore destroys the current mode.
Fails
The function fails if the type checker finds a type error in the specification and returns a string with a detailed description.
source§impl RtLolaHir<TypedMode>
impl RtLolaHir<TypedMode>
sourcepub fn analyze_dependencies(self) -> Result<RtLolaHir<DepAnaMode>, RtLolaError>
pub fn analyze_dependencies(self) -> Result<RtLolaHir<DepAnaMode>, RtLolaError>
Returns the RtLolaHir with additional information about the dependencies between streams
The function returns the RtLolaHir after the dependency analysis. The new mode implements the same functionality as the TypedMode and additionally contains the dependencies between streams in the specification. The function moves the information of the previous mode to the new one and therefore destroys the current mode.
Fails
The function returns a RtLolaError if the specification is not well-formed.
source§impl RtLolaHir<DepAnaMode>
impl RtLolaHir<DepAnaMode>
sourcepub fn determine_evaluation_order(
self
) -> Result<RtLolaHir<OrderedMode>, RtLolaError>
pub fn determine_evaluation_order(
self
) -> Result<RtLolaHir<OrderedMode>, RtLolaError>
source§impl RtLolaHir<OrderedMode>
impl RtLolaHir<OrderedMode>
sourcepub fn determine_memory_bounds(
self
) -> Result<RtLolaHir<MemBoundMode>, RtLolaError>
pub fn determine_memory_bounds(
self
) -> Result<RtLolaHir<MemBoundMode>, RtLolaError>
source§impl RtLolaHir<MemBoundMode>
impl RtLolaHir<MemBoundMode>
sourcepub fn finalize(self) -> Result<RtLolaHir<CompleteMode>, RtLolaError>
pub fn finalize(self) -> Result<RtLolaHir<CompleteMode>, RtLolaError>
Returns the RtLolaHir in the last mode
The function returns the RtLolaHir in the CompleteMode. This mode indicates that the RtLolaHir has passed all analyzes and now contains all information. The function moves the information of the previous mode to the new one and therefore destroys the current mode.