moonrockz/gleam-parser/fuel

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
U
BindingError
U
BitArrayOption
U
BitArraySegment
U
BitArraySize
U
BitArrayUnit
U
Budget
U
ByteLength
U
ByteOffset
U
CallArg
U
ChildIndex
U
Clause
U
ClauseGuard
U
ColumnNumber
U
Comment
U
CommentError
U
CommentKind
U
Config
U
ConfigError
U
Constant
U
Control
U
CoordinateError
U
CustomType
U
DecodeError
U
Definition
U
DefinitionCst
U
DefinitionKind
U
Deprecation
U
Diagnostic
U
Dialect
U
Documentation
U
EnterEvent
U
Environment
U
Event
U
EventReader
U
EventSource
U
ExportError
U
Expr
U
Extended
U
ExtendedError
U
External
U
ExternalBinding
U
ExternalBindings
U
FormatError
U
Fuel
U
FuelExhausted
U
Function
U
FunctionLiteralKind
U
Handler
U
ImplicitCallArgOrigin
U
Import
U
ImportAlias
U
IncorrectNamePosition
U
IntOperator
U
InvalidBitArrayUnit
U
InvalidBudget
U
Keyword
U
Label
U
LeaveEvent
U
LexicalErrorType
U
LineCount
U
LineNumber
U
Module
U
ModuleConstant
U
ModuleCst
U
ModuleExtra
U
NestingLimit
U
NodeDepth
U
NodePath
U
NodeRef
U
Operation
U
OracleOutput
U
ParseError
U
ParseErrorDetails
U
ParseErrorType
U
ParseResult
U
Parsed
U
Partial
U
PathStep
U
Pattern
U
Position
U
Profile
U
ProfileError
U
Profiles
U
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
RegistrationError
U
Rule
U
Severity
U
Source
U
SourceText
U
SpannedString
U
Spent
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
U
TargetName
U
TargetRegistry
U
TargetedDefinition
U
TodoKind
U
Token
U
TokenKind
U
TokenStream
U
TraversalValueError
U
Tree
U
TreeCursor
U
Trivia
U
TupleIndex
U
TypeAlias
U
TypeAst
U
TypeAstConstructor
U
TypeAstConstructorName
U
TypeAstFn
U
TypeAstHole
U
TypeAstTuple
U
TypeAstVar
U
UnicodeEscapeError
U
UnqualifiedImport
U
Use
U
UseAssignment
U
Utf16Offset
U
Visitor
U
Warning
V
accept
V
canonical
V
decode_expr
V
decode_extended
V
decode_oracle_output
V
decode_parsed
V
default_budget
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
V
encode_extended
V
encode_oracle_output
V
encode_parsed
V
fold
V
format
V
format_parsed
V
kind_table
V
parse_float_value
V
parse_int_value
V
parse_module
V
parse_text
V
push_events
V
reduce
V
reduce_with_fields
V
render_plain
V
render_terminal
V
tokenize
V
tokenize_text
V
version
V
walk

moonrockz/gleam-parser/fuel does not have a README file

FuelExhausted

pub(all) suberror FuelExhausted {
  FuelExhausted(budget~ : Budget, spent~ : Array[Spent])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The budget ran out: spent is the stack at that moment, outermost first.

InvalidBudget

source

pub(all) suberror InvalidBudget {
  InvalidBudget(Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A recursion budget must contain at least one unit.

Budget

source

pub struct Budget {
  // private fields
} derive(Compare, Eq, @moonbitlang/core/debug.Debug
Debug)

Units of fuel, at least 1.

test {
  debug_inspect(
    @fuel.Budget::from_int(100).map(b => b.units()),
    content="Some(100)",
  )
  debug_inspect(@fuel.Budget::from_int(0), content="None")
}

Budget::Budget

source

fn Budget::Budget(units : Int) -> Budget raise InvalidBudget

Create a recursion budget. Raise InvalidBudget below one unit. Use from_int to get Option.

test {
  assert_eq(@fuel.Budget(100).units(), 100)
}

Budget::from_int

source

#alias(new, deprecated="Use `Budget::from_int(...)` instead")
fn Budget::from_int(units : Int) -> Budget?

A budget of units; None below 1.

Budget::units

source

fn Budget::units(self : Budget) -> Int

The number of units.

Fuel

source

pub struct Fuel {
  budget : Budget
  left : Int
  ops : @moonbitlang/core/list.List
List[Operation]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An immutable fuel value: the budget, the units not yet spent, and the operations on the stack (innermost first). spend gives a new value; there is no restore: the enclosing operation keeps its own Fuel.

test {
  let f = @fuel.Fuel(budget=@fuel.Budget::from_int(2).unwrap())
  let inner = f.spend(@fuel.Operation("expression"))
  inspect(inner.left(), content="1")
  inspect(f.left(), content="2")
}

Fuel::Fuel

source

#alias(new, deprecated="Use `Fuel(...)` instead")
fn Fuel::Fuel(budget? : Budget) -> Fuel

A full budget (default_budget when none is given).

Fuel::budget

source

fn Fuel::budget(self : Fuel) -> Budget

The budget this fuel started with.

Fuel::left

source

fn Fuel::left(self : Fuel) -> Int

The units not yet spent.

Fuel::spend

source

fn Fuel::spend(self : Fuel, op : Operation) -> Fuel raise FuelExhausted

Enter a nested operation: one unit less, op on the stack. Raises FuelExhausted with the budget and the stack when no unit is left.

Fuel::spent

source

fn Fuel::spent(self : Fuel) -> Array[Spent]

The distinct operations on the stack, outermost first, each with the number of levels it holds.

NestingLimit

source

pub(all) enum NestingLimit {
  Unlimited
  Limited(Budget)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An optional limit on syntax nesting. Unlimited is the parser default. A finite limit is a caller policy and is independent of machine stack size.

test {
  let limit : @fuel.NestingLimit = Limited(@fuel.Budget(500))
  debug_inspect(limit.budget().map(b => b.units()), content="Some(500)")
  debug_inspect(@fuel.NestingLimit::Unlimited.budget(), content="None")
}

NestingLimit::budget

source

fn NestingLimit::budget(self : NestingLimit) -> Budget?

Return the finite budget, or None when nesting is unrestricted.

Operation

source

pub(all) struct Operation(String) derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

The name of a fuel-checked operation (expression, pattern, ...). Each package that spends fuel defines its operations as constants.

Operation::name

source

fn Operation::name(self : Operation) -> String

The operation's name.

Operation::new

source

#deprecated("Use `Operation(name)` instead")
fn Operation::new(name : String) -> Operation

Use Operation(name) to name a fuel-checked operation.

Spent

source

pub(all) struct Spent {
  operation : Operation
  levels : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One operation on the stack with the number of nested levels it holds.

default_budget

source

let default_budget : Budget

The finite budget used by Fuel() when no budget is supplied: 100 units. Parser and formatter configurations default to Unlimited instead.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#FuelExhausted

#InvalidBudget

#Budget

#Budget::Budget

#Budget::from_int

#Budget::units

#Fuel

#Fuel::Fuel

#Fuel::budget

#Fuel::left

#Fuel::spend

#Fuel::spent

#NestingLimit

#NestingLimit::budget

#Operation

#Operation::name

#Operation::new

#Spent

#default_budget

Source Files

FuelExhausted

InvalidBudget

Budget

Budget::Budget

Budget::from_int

Budget::units

Fuel

Fuel::Fuel

Fuel::budget

Fuel::left

Fuel::spend

Fuel::spent

NestingLimit

NestingLimit::budget

Operation

Operation::name

Operation::new

Spent

default_budget