Skip to content

chore: add stack overflow warning for Visitor and VisitorMut #2068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 16, 2025
Merged

chore: add stack overflow warning for Visitor and VisitorMut #2068

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
476ccf6
add important note for Visitor and VisitorMut
niebayes Oct 15, 2025
d92528c
move note
niebayes Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/ast/visitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@ visit_noop!(bigdecimal::BigDecimal);
/// ```
pub trait Visitor {
/// Type returned when the recursion returns early.
///
/// Important note: The `Break` type should be kept as small as possible to prevent
/// stack overflow during recursion. If you need to return an error, consider
/// boxing it with `Box` to minimize stack usage.
type Break;

/// Invoked for any queries that appear in the AST before visiting children
Expand Down Expand Up @@ -290,6 +294,10 @@ pub trait Visitor {
/// ```
pub trait VisitorMut {
/// Type returned when the recursion returns early.
///
/// Important note: The `Break` type should be kept as small as possible to prevent
/// stack overflow during recursion. If you need to return an error, consider
/// boxing it with `Box` to minimize stack usage.
type Break;

/// Invoked for any queries that appear in the AST before visiting children
Expand Down