A Template includes an ordered list of placeholders and text segments. Templates coming from this module guarantee that:

> not (List.isEmpty segments)
> List.length segments == List.length placeholders + 1

A parser for a Template based on a Syntax. In this form, it can be combined nicely with other Parsers.

Parse a String into a Template based on a Syntax. Example:

> parseTemplate { startSymbol = "${", endSymbol = "}" } "This is ${name}s example"
{ segments = ["This is ", "s example"], placeholders = ["name"]}

A Syntax tells the templateParser how to distinguish placeholders from regular text. At the moment, this can only be configured by setting start and end symbol.

Parse a String into a function substituting the argument at the position marked by the Syntax. Examples:

> f = parsePlaceholder1 { startSymbol = "${", endSymbol = "}" } "This is ${name}s example"
Ok <function> : Result String (F1 String)


> Result.map ((|>) "Andy") f
Ok ("This is Andys example") : Result String String


> parsePlaceholder1 { startSymbol = "${", endSymbol = "}" } "No placeholder"
Err ("Expected more placeholders.") : Result String (F1 String)


> parsePlaceholder1 { startSymbol = "${", endSymbol = "}" } "${multiple}${placeholders}"
Err ("Expected less placeholders.") : Result String (F1 String)

Parse a String into a function substituting the arguments at the two positions marked by the Syntax.

Parse a String into a function substituting the arguments at the three positions marked by the Syntax.

Parse a String into a function substituting the arguments at the four positions marked by the Syntax.