sheen

Types

Command

pub type Command(a) =
  cb.Command(a)

ParseResult

</>

pub type ParseResult(a) =
  Result(a, List(ParseError))

Parser

</>

pub type Parser(a) {
  Parser(
    spec: ParserSpec,
    encoders: endec.Encoders,
    decoder: endec.Decoder(a),
  )
}

Constructors

Parser(
  spec: ParserSpec,
  encoders: endec.Encoders,
  decoder: endec.Decoder(a),
)

ParserSpec

</>

pub type ParserSpec {
  ParserSpec(
    cmd: cb.CommandSpec,
    name: option.Option(String),
    authors: List(String),
    version: option.Option(String),
  )
}

Constructors

ParserSpec(
  cmd: cb.CommandSpec,
  name: option.Option(String),
  authors: List(String),
  version: option.Option(String),
)

Functions

authors

</>

pub fn authors(
  to parser: ParserSpec,
  set authors: List(String),
) -> ParserSpec

build

</>

pub fn build(
  from parser: ParserSpec,
  with command: fn(Builder(Nil)) -> Result(Builder(a), String),
) -> Result(Parser(a), String)

describe

</>

pub fn describe(
  description: String,
  cont: fn() -> fn(Builder(Nil)) -> Result(Builder(a), String),
) -> fn(Builder(Nil)) -> Result(Builder(a), String)

name

</>

pub fn name(
  to parser: ParserSpec,
  set name: String,
) -> ParserSpec

new

</>

pub fn new() -> ParserSpec

return

</>

pub fn return(
  decoder: Decoder(a),
) -> fn(Builder(Nil)) -> Result(Builder(a), String)

run

</>

pub fn run(
  parser: Parser(a),
  args: List(String),
) -> Result(a, List(ParseError))

usage

</>

pub fn usage(spec: ParserSpec) -> Document

valid

</>

pub fn valid(value: a) -> Decoder(a)

version

</>

pub fn version(
  to parser: ParserSpec,
  set version: String,
) -> ParserSpec