Struct Route

pub struct Route<'a> { /* private fields */ }

The route the engine took during compilation. This is used to detect cyclic imports and excessive nesting.

Implementations

impl<'a> Route<'a>

pub fn root() -> Self

Create a new, empty route.

pub fn extend(outer: Tracked<'a, Self>) -> Self

Extend the route with another segment with a default length of 1.

pub fn with_id(self, id: FileId) -> Self

Attach a file id to the route segment.

pub fn unnested(self) -> Self

Set the length of the route segment to zero.

pub fn track(&self) -> Tracked<'_, Self>

Start tracking this route.

In comparison to Track::track, this method skips this chain link if it does not contribute anything.

pub fn increase(&mut self)

Increase the nesting depth for this route segment.

pub fn decrease(&mut self)

Decrease the nesting depth for this route segment.

impl Route<'_>

The maximum nesting depths. They are different so that even if show rule and call checks are interleaved, for show rule problems we always get the show rule error. The lower the max depth for a kind of error, the higher its precedence compared to the others.

pub fn check_show_depth(&self) -> HintedStrResult<()>

Ensures that we are within the maximum show rule depth.

pub fn check_layout_depth(&self) -> HintedStrResult<()>

Ensures that we are within the maximum layout depth.

pub fn check_html_depth(&self) -> HintedStrResult<()>

Ensures that we are within the maximum HTML depth.

pub fn check_call_depth(&self) -> StrResult<()>

Ensures that we are within the maximum function call depth.

impl<'a> Route<'a>

pub fn contains(&self, id: FileId) -> bool

Whether the given id is part of the route.

pub fn within(&self, depth: usize) -> bool

Whether the route’s depth is less than or equal to the given depth.

Trait Implementations

impl Clone for Route<'_>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Route<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Track for Route<'a>

fn track(&self) -> Tracked<'_, Self>

Start tracking all accesses to a value.

fn track_mut(&mut self) -> TrackedMut<'_, Self>

Start tracking all accesses and mutations to a value.

fn track_with<'a>( &'a self, constraint: &'a Self::Constraint, ) -> Tracked<'a, Self>

Start tracking all accesses into a constraint.

fn track_mut_with<'a>( &'a mut self, constraint: &'a Self::Constraint, ) -> TrackedMut<'a, Self>

Start tracking all accesses and mutations into a constraint.

impl<'a> Validate for Route<'a>

type Constraint = ImmutableConstraint<__ComemoCall>

The constraints for this type.

fn validate(&self, constraint: &Self::Constraint) -> bool

Whether this value fulfills the given constraints.

fn validate_with_id(&self, constraint: &Self::Constraint, id: usize) -> bool

Accelerated version of validate.

fn replay(&mut self, constraint: &Self::Constraint)

Replay recorded mutations to the value.