moonbitstack/moonconf/expand

README
- ::outputRefused::output
- ::to_stringRefused::to_string
- ::equalAt::equal
- ::not_equalAt::not_equal
- ::ofAt::of
- ::to_reprAt::to_repr
- ::equalBind::equal
- ::not_equalBind::not_equal
- ::to_reprBind::to_repr
- ::equalClash::equal
- ::not_equalClash::not_equal
- ::to_reprClash::to_repr
- ::equalExtra::equal
- ::not_equalExtra::not_equal
- ::to_reprExtra::to_repr
- ::equalKnobs::equal
- ::not_equalKnobs::not_equal
- ::to_reprKnobs::to_repr
- ::boolNode::bool
- ::copyNode::copy
- ::equalNode::equal
- ::findNode::find
- ::flagNode::flag
- ::fromNode::from
- ::hasNode::has
- ::intNode::int
- ::is_listNode::is_list
- ::is_mapNode::is_map
- ::kindNode::kind
- ::listNode::list
- ::mapNode::map
- ::mergeNode::merge
- ::needNode::need
- ::need_boolNode::need_bool
- ::need_intNode::need_int
- ::need_textNode::need_text
- ::newNode::new
- ::not_equalNode::not_equal
- ::numNode::num
- ::of_realNode::of_real
- ::realNode::real
- ::seqNode::seq
- ::strNode::str
- ::tableNode::table
- ::textNode::text
- ::to_reprNode::to_repr
- ::equalSource::equal
- ::newSource::new
- ::not_equalSource::not_equal
- ::to_reprSource::to_repr
- ::copyTable::copy
- ::equalTable::equal
- ::getTable::get
- ::hasTable::has
- ::is_emptyTable::is_empty
- ::itemsTable::items
- ::keysTable::keys
- ::lengthTable::length
- ::newTable::new
- ::not_equalTable::not_equal
- ::removeTable::remove
- ::setTable::set
- ::to_reprTable::to_repr
- ::equalTier::equal
- ::not_equalTier::not_equal
- ::to_reprTier::to_repr
- ::equalValue::equal
- ::not_equalValue::not_equal
- ::to_reprValue::to_repr
V
bind
V
closed
V
decimal
V
layered
V
merge
V
native
V
of_json
V
of_toml
V
of_yaml
V
open
V
segments
V
spot
V
start
V
validate
V
whole

moonbitstack/moonconf/expand does not have a README file

Refused

pub(all) suberror Refused {
  Unclosed(at~ : At)
  BadName(at~ : At, got~ : String)
  BadOperator(at~ : At, got~ : String)
  Undefined(name~ : String, at~ : At)
  ReadOnly(name~ : String, at~ : At)
  Required(name~ : String, why~ : String, at~ : At)
  TooDeep(at~ : At, limit~ : Int)
}

Why a text was refused.

impl Show for Refused

Refused::output

source

fn Refused::output(self : Refused, logger : &Logger) -> Unit

Refused::to_string

source

fn Refused::to_string(self : Refused) -> String

At

source

pub(all) struct At {
  at : Int
  line : Int
  column : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Where in the text something went wrong.

At::equal

source

fn At::equal(At, At) -> Bool

At::not_equal

source

fn At::not_equal(x : At, y : At) -> Bool

At::to_repr

source

fn At::to_repr(At) -> @moonbitlang/core/debug.Repr
Repr

Knobs

source

pub(all) struct Knobs {
  unset : Unset
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

How far to expand.

Knobs::equal

source

fn Knobs::equal(Knobs, Knobs) -> Bool

Knobs::not_equal

source

fn Knobs::not_equal(x : Knobs, y : Knobs) -> Bool

Knobs::to_repr

source

fn Knobs::to_repr(Knobs) -> @moonbitlang/core/debug.Repr
Repr

Unset

source

pub(all) enum Unset {
  Fail
  Empty
  Keep
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What a reference to a variable that has no value means.

Unset::equal

source

fn Unset::equal(Unset, Unset) -> Bool

Unset::not_equal

source

fn Unset::not_equal(x : Unset, y : Unset) -> Bool

Unset::to_repr

source

fn Unset::to_repr(Unset) -> @moonbitlang/core/debug.Repr
Repr

Vars

source

pub(all) struct Vars {
  get : (String) -> String?
  set : (String, String) -> Unit?
}

The variables a text may refer to, and where ${A:=b} writes.

Reading is one function and writing is another rather than a map, because the thing a caller has is usually not a map: the process environment cannot be written, a layered configuration writes to its override layer, and a test writes to a small table. A Vars with no set is read-only, and an assignment through it is refused rather than dropped.

Vars::lookup

source

fn Vars::lookup(self : Vars, name : String) -> String?

The value of name, or nothing.

Vars::none

source

fn Vars::none() -> Vars

No variables at all.

Vars::of

source

fn Vars::of(get : (String) -> String?) -> Vars

The variables of a function, which cannot be assigned to.

Vars::of_map

source

fn Vars::of_map(entries : Map[String, String]) -> Vars

The entries of a map, which an assignment updates.

Vars::write

source

fn Vars::write(self : Vars, name : String, value : String) -> Bool

Write name, answering whether there was anywhere to write it.

Vars::writing

source

fn Vars::writing(get : (String) -> String?, set : (String, String) -> Unit) -> Vars

The variables of a function, which an assignment also updates.

deferred

source

let deferred : Knobs

A reference to an unset variable is left as written.

depth

source

let depth : Int

The limit on nested forms. ${A:-${B:-${C}}} is three; a text that nests itself a thousand times is a mistake, and the recursion has to stop somewhere short of the stack.

expand

source

fn expand(text : StringView, vars : Vars, knobs? : Knobs) -> String raise Refused

Expand a text in the POSIX shell's parameter syntax.

${A}, $A, ${A:-b}, ${A-b}, ${A:=b}, ${A=b}, ${A:?msg}, ${A?msg}, ${A:+b}, ${A+b} and ${#A}, with \ escaping $, \, " and a backtick, and the word inside any of the forms expanded in turn. The colon forms also treat an empty value as missing, as the shell does.

A variable with no value is an error by default: a caller who knows an empty string is meant asks for [lenient], and one that expands in two passes asks for { unset: Keep }.

lenient

source

let lenient : Knobs

A reference to an unset variable reads as empty.

strict

source

let strict : Knobs

A reference to an unset variable is an error.

Source Files

Install

Download zip

Configuration files, their expansion, their layering and their binding to a typed model.

configconfigurationinipropertiesjava-propertiesdotenvenvhoconhclvariable-expansioninterpolationlayeringbindingsettingsmoonbit

moonbitstack

Apache-2.0

github.com/moonbitstack/moonconf

Updated 2 days ago

71 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#Refused

#Refused::output

#Refused::to_string

#At

#At::equal

#At::not_equal

#At::to_repr

#Knobs

#Knobs::equal

#Knobs::not_equal

#Knobs::to_repr

#Unset

#Unset::equal

#Unset::not_equal

#Unset::to_repr

#Vars

#Vars::lookup

#Vars::none

#Vars::of

#Vars::of_map

#Vars::write

#Vars::writing

#deferred

#depth

#expand

#lenient

#strict

Source Files

Refused

Refused::output

Refused::to_string

At

At::equal

At::not_equal

At::to_repr

Knobs

Knobs::equal

Knobs::not_equal

Knobs::to_repr

Unset

Unset::equal

Unset::not_equal

Unset::to_repr

Vars

Vars::lookup

Vars::none

Vars::of

Vars::of_map

Vars::write

Vars::writing

deferred

depth

expand

lenient

strict