Struct rtlola_hir::hir::RtLolaHir [−][src]
pub struct RtLolaHir<M: HirMode> { /* fields omitted */ }
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
Provides access to an iterator over all input streams.
Provides access to an iterator over all output streams.
Provides access to an iterator over all triggers.
Yields the number of input streams present in the Hir. Not necessarily equal to the number of input streams in the specification.
Yields the number of output streams present in the Hir. Not necessarily equal to the number of output streams in the specification.
Yields the number of triggers present in the Hir. Not necessarily equal to the number of triggers in the specification.
Provides access to an iterator over all streams, i.e., inputs, outputs, and triggers.
Retrieves an input stream based on its name. Fails if no such input stream exists.
Retrieves an output stream based on its name. Fails if no such output stream exists.
Retrieves an output stream based on a stream reference. Fails if no such stream exists or sref
is a StreamReference::In.
Retrieves an input stream based on a stream reference. Fails if no such stream exists or sref
is a StreamReference::Out.
Provides access to a collection of references for all windows occurring in the Hir.
Provides access to a collection of references for all sliding windows occurring in the Hir.
Provides access to a collection of references for all discrete windows occurring in the Hir.
Retrieves a function declaration for a given function name.
Panic
Panics if the declaration does not exist.
Retrieves the stream expression of a particular output stream or trigger.
Panic
Panics if the reference is a StreamReference::In or the stream does not exist.
Retrieves the expression representing the activation condition of a particular output stream or trigger or None
for input references.
Panic
Panics if the stream does not exist.
Retrieves the spawn definition of a particular output stream or trigger or None
for input references.
Panic
Panics if the stream does not exist.
Retrieves the expression representing the filter condition of a particular output stream or trigger or None
for input references.
Panic
Panics if the stream does not exist.
Retrieves the expression representing the close condition of a particular output stream or trigger or None
for input references.
Panic
Panics if the stream does not exist.
pub fn analyze_dependencies(
self,
handler: &Handler
) -> Result<RtLolaHir<DepAnaMode>, DependencyErr>
pub fn analyze_dependencies(
self,
handler: &Handler
) -> Result<RtLolaHir<DepAnaMode>, DependencyErr>
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 BaseMode 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 DependencyErr if the specification is not well-formed.
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 DepAnaMode 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.
pub fn determine_evaluation_order(
self,
handler: &Handler
) -> Result<RtLolaHir<OrderedMode>, OrderErr>
pub fn determine_evaluation_order(
self,
handler: &Handler
) -> Result<RtLolaHir<OrderedMode>, OrderErr>
pub fn determine_memory_bounds(
self,
handler: &Handler
) -> Result<RtLolaHir<MemBoundMode>, MemBoundErr>
pub fn determine_memory_bounds(
self,
handler: &Handler
) -> Result<RtLolaHir<MemBoundMode>, MemBoundErr>
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.
Trait Implementations
type Error = DependencyErr
type Error = DependencyErr
Defines the Error type of the progress
function
type NextStage = DepAnaMode
type NextStage = DepAnaMode
Defines the next mode that is produced by the progress
function
type NextStage = TypedMode
type NextStage = TypedMode
Defines the next mode that is produced by the progress
function
type Error = OrderErr
type Error = OrderErr
Defines the Error type of the progress
function
type NextStage = OrderedMode
type NextStage = OrderedMode
Defines the next mode that is produced by the progress
function
type Error = MemBoundErr
type Error = MemBoundErr
Defines the Error type of the progress
function
type NextStage = MemBoundMode
type NextStage = MemBoundMode
Defines the next mode that is produced by the progress
function
type Error = CompletionErr
type Error = CompletionErr
Defines the Error type of the progress
function
type NextStage = CompleteMode
type NextStage = CompleteMode
Defines the next mode that is produced by the progress
function
Auto Trait Implementations
impl<M> RefUnwindSafe for RtLolaHir<M> where
M: RefUnwindSafe,
impl<M> UnwindSafe for RtLolaHir<M> where
M: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = T
Should always be Self