moonrockz/gleam-parser/config

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
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
Expr
U
External
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
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
Rule
U
Severity
U
Source
U
SourceText
U
SpannedString
U
Spent
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
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_oracle_output
V
decode_parsed
V
default_budget
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
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/config does not have a README file

ConfigError

pub(all) suberror ConfigError {
  ConfigError(source~ : Source, message~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A configuration value that cannot be used. Nothing falls back silently.

Config

source

pub(all) struct Config {
  dialect : @moonrockz/gleam-parser/dialect.Dialect
Dialect
  fuel : @moonrockz/gleam-parser/fuel.NestingLimit
NestingLimit
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The dialect and optional nesting policy for parsing and formatting. fuel: Unlimited accepts any depth that fits in available memory. Use Limited(Budget(...)) to impose a caller-selected depth limit.

test {
  let c = @config.Config::default()
  debug_inspect(c.fuel, content="Unlimited")
  inspect(c.dialect.name, content="gleam-1.19")
}

Config::default

source

fn Config::default() -> Config

Dialect::gleam_1_19() with unlimited nesting.

Config::from_env

source

fn Config::from_env(env : Environment) -> Partial raise ConfigError

GLEAM_PARSER_GLEAM and GLEAM_PARSER_FUEL from env. An unset variable leaves the field unset; an empty or bad value is a ConfigError that names the variable. GLEAM_PARSER_FUEL=unlimited clears a fallback's finite limit.

Config::from_toml

source

fn Config::from_toml(text : String) -> Partial raise ConfigError

The [parser] table of a gleam-parser.toml text: gleam = "1.19", fuel = 100 or fuel = "unlimited". Every key is optional. An omitted fuel key inherits the fallback. The default is unlimited. A syntax error, an unknown table or key, a value of the wrong type, a fuel below 1 or an unknown Gleam version is a ConfigError that names its source.

test {
  let p = @config.Config::from_toml("[parser]\nfuel = 550\n")
  debug_inspect(
    p.fuel.bind(limit => limit.budget()).map(b => b.units()),
    content="Some(550)",
  )
  inspect(p.dialect is None, content="true")
}

Config::load

source

fn Config::load(path? : String, env? : Environment) -> Config raise ConfigError

The configuration from the environment over the TOML file over the defaults. path is gleam-parser.toml by default; a missing file contributes nothing, a file that cannot be read is a ConfigError with File(path) and the system's text, and a TOML error from the file names the file in front of its message. The only function of this package with I/O.

fn parse_with_config(text : String) -> @gleam.ParseResult raise {
  let config = @gleam.Config::load()
  @gleam.parse_text(text, config~)
}

Config::to_partial

source

fn Config::to_partial(self : Config) -> Partial

Every field set.

Config::with_fallback

source

fn Config::with_fallback(self : Config, over : Partial) -> Config

over's set fields replace this config's fields.

Environment

source

pub struct Environment((String) -> String?)

The variables a configuration reads: the process environment, or a map (for tests and for callers that bring their own).

Environment::get

source

fn Environment::get(self : Environment, name : String) -> String?

The value of the variable name, or None when it is not set.

Environment::of

source

fn Environment::of(vars : Map[String, String]) -> Environment

A fixed set of variables.

Environment::system

source

fn Environment::system() -> Environment

The process environment (@env.get_env_var), on every target.

Partial

source

pub(all) struct Partial {
  dialect : @moonrockz/gleam-parser/dialect.Dialect
Dialect?
  fuel : @moonrockz/gleam-parser/fuel.NestingLimit
NestingLimit?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A layer of configuration: each field set or unset. Some(Unlimited) clears a fallback's limit; None inherits it.

Partial::empty

source

fn Partial::empty() -> Partial

No field set.

Partial::to_config

source

fn Partial::to_config(self : Partial, fallback : Config) -> Config

A full config: unset fields come from fallback.

Partial::with_fallback

source

fn Partial::with_fallback(self : Partial, fallback : Partial) -> Partial

This layer's set fields win; unset fields come from fallback.

test {
  let file : @config.Partial = {
    dialect: None,
    fuel: @fuel.Budget::from_int(500).map(b => Limited(b)),
  }
  let env : @config.Partial = {
    dialect: None,
    fuel: @fuel.Budget::from_int(2000).map(b => Limited(b)),
  }
  let c = env.with_fallback(file).to_config(@config.Config::default())
  debug_inspect(c.fuel.budget().map(b => b.units()), content="Some(2000)")
}

Source

source

pub(all) enum Source {
  Default
  TomlKey(String)
  TomlSyntax
  EnvVar(String)
  File(String)
  Caller
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)