vxml_pipeline - v0.3.0

vxml_pipeline/authoring

Constructors and blame helpers for client-authored desugarers.

A parameterized desugarer normally has two construction phases. prepare validates its public parameter and performs reusable work such as compiling regular expressions or building dictionaries. It returns an inner parameter, which transform captures in the VXML transformation function. Preparation occurs once when the pipeline is constructed, not once per visited VXML node.

Values

blame

</> 
pub fn blame(name: String, line_no: Int) -> blame.Blame

Creates desugarer blame for a value introduced at line_no in the named desugarer module.

desugarer

</> 
pub fn desugarer(
  name name: String,
  param param: a,
  prepare prepare: fn(a) -> Result(b, core.DesugaringError),
  transform transform: fn(b) -> fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a parameterized desugarer with fallible parameter preparation.

The parameter is represented in diagnostic pipeline tables with string.inspect. If prepare fails, the resulting desugarer returns that error whenever the pipeline attempts to run it.

desugarer_with_outside

</> 
pub fn desugarer_with_outside(
  name name: String,
  param param: a,
  outside outside: b,
  prepare prepare: fn(a) -> Result(c, core.DesugaringError),
  transform transform: fn(c, b) -> fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a parameterized __outside desugarer.

outside is recorded separately in diagnostic pipeline tables and passed unchanged to transform. The constructor validates and prepares only param.

desugarer_with_stringified_param

</> 
pub fn desugarer_with_stringified_param(
  name name: String,
  param param: a,
  stringified_param stringified_param: String,
  prepare prepare: fn(a) -> Result(b, core.DesugaringError),
  transform transform: fn(b) -> fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a parameterized desugarer with a caller-supplied diagnostic representation of its parameter.

infallible_desugarer

</> 
pub fn infallible_desugarer(
  name name: String,
  param param: a,
  transform transform: fn(a) -> fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a parameterized desugarer that requires no fallible preparation.

Use this when the public parameter can be captured directly by the transform factory.

no_param_desugarer

</> 
pub fn no_param_desugarer(
  name name: String,
  transform transform: fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a desugarer that has no public parameter.

no_param_desugarer_with_outside

</> 
pub fn no_param_desugarer_with_outside(
  name name: String,
  outside outside: a,
  transform transform: fn(a) -> fn(vxml.VXML) -> Result(
    #(vxml.VXML, List(core.DesugaringWarning)),
    core.DesugaringError,
  ),
) -> core.Desugarer

Constructs a parameterless __outside desugarer.

The outside-tag list is the desugarer’s only constructor input and is shown in the outside column of diagnostic pipeline tables.

✨ Search Document