ArgParser (Fake)

ArgParser Module

Namespace: Fake.Core.CommandLineParsing
Assembly: Fake.Core.CommandLineParsing.dll

Types

Type	Description
Inline

Functions and values

Function or value	Description
`p1 .>> p2` Full Usage: `p1 .>> p2` Parameters: p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'b>`	p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'b>`
`p1 .>>. p2` Full Usage: `p1 .>>. p2` Parameters: p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'b * 'c>`	p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'b * 'c>`
`p label` Full Usage: `p label` Parameters: p : `ArgumentParser<'u, 'a>` label : `string` Returns: `ArgumentParser<'u, 'a>`	p : `ArgumentParser<'u, 'a>` label : `string` Returns: `ArgumentParser<'u, 'a>`
`p1 <\|> p2` Full Usage: `p1 <\|> p2` Parameters: p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'b>` Returns: `IArgumentStream<'a> -> Reply<'b>`	p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'b>` Returns: `IArgumentStream<'a> -> Reply<'b>`
`p >>% x` Full Usage: `p >>% x` Parameters: p : `ArgumentParser<'a, 'b>` x : `'c` Returns: `IArgumentStream<'a> -> Reply<'c>`	p : `ArgumentParser<'a, 'b>` x : `'c` Returns: `IArgumentStream<'a> -> Reply<'c>`
`p1 >>. p2` Full Usage: `p1 >>. p2` Parameters: p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'c>`	p1 : `ArgumentParser<'a, 'b>` p2 : `ArgumentParser<'a, 'c>` Returns: `IArgumentStream<'a> -> Reply<'c>`
`(>>=) p f stream` Full Usage: `(>>=) p f stream` Parameters: p : `ArgumentParser<'u, 'a>` f : `'a -> ArgumentParser<'u, 'b>` stream : `IArgumentStream<'u>` Returns: `Reply<'b>`	p : `ArgumentParser<'u, 'a>` f : `'a -> ArgumentParser<'u, 'b>` stream : `IArgumentStream<'u>` Returns: `Reply<'b>`
`p \|>> f` Full Usage: `p \|>> f` Parameters: p : `ArgumentParser<'a, 'b>` f : `'b -> 'c` Returns: `IArgumentStream<'a> -> Reply<'c>`	p : `ArgumentParser<'a, 'b>` f : `'b -> 'c` Returns: `IArgumentStream<'a> -> Reply<'c>`
`between popen pclose p` Full Usage: `between popen pclose p` Parameters: popen : `ArgumentParser<'u, 'u>` pclose : `ArgumentParser<'u, 'a>` p : `ArgumentParser<'u, 'b>` Returns: `IArgumentStream<'u> -> Reply<'b>`	popen : `ArgumentParser<'u, 'u>` pclose : `ArgumentParser<'u, 'a>` p : `ArgumentParser<'u, 'b>` Returns: `IArgumentStream<'u> -> Reply<'b>`
`choice ps stream` Full Usage: `choice ps stream` Parameters: ps : `seq<ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a>`	ps : `seq<ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a>`
`choiceBest ps stream` Full Usage: `choiceBest ps stream` Parameters: ps : `seq<ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a>`	ps : `seq<ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a>`
`chooseParser itemType chooser stream` Full Usage: `chooseParser itemType chooser stream` Parameters: itemType : `string` chooser : `string option -> 'a option` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`	itemType : `string` chooser : `string option -> 'a option` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`
`chooseParser' itemType chooser` Full Usage: `chooseParser' itemType chooser` Parameters: itemType : `string` chooser : `string -> 'a option` Returns: `IArgumentStream<'b> -> Reply<'a>`	itemType : `string` chooser : `string -> 'a option` Returns: `IArgumentStream<'b> -> Reply<'a>`
`chooseParserFull itemType chooser stream` Full Usage: `chooseParserFull itemType chooser stream` Parameters: itemType : `string` chooser : `string option -> 'a option` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`	itemType : `string` chooser : `string option -> 'a option` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`
`chooseParserFull' itemType chooser` Full Usage: `chooseParserFull' itemType chooser` Parameters: itemType : `string` chooser : `string -> 'a option` Returns: `IArgumentStream<'b> -> Reply<'a>`	itemType : `string` chooser : `string -> 'a option` Returns: `IArgumentStream<'b> -> Reply<'a>`
`debug map' arg' stream'` Full Usage: `debug map' arg' stream'` Parameters: map' : `'a -> IArgumentStream<'state> -> unit` arg' : `'a` stream' : `IArgumentStream<'state>` Returns: `Reply<'a>`	map' : `'a -> IArgumentStream<'state> -> unit` arg' : `'a` stream' : `IArgumentStream<'state>` Returns: `Reply<'a>`
`getParser ast` Full Usage: `getParser ast` Parameters: ast : `UsageAst` Returns: `ArgumentParser<DocoptMap, Map<string, DocoptResult>>`	ast : `UsageAst` Returns: `ArgumentParser<DocoptMap, Map<string, DocoptResult>>`
`many p` Full Usage: `many p` Parameters: p : `ArgumentParser<'a, 'b>` Returns: `ArgumentParser<'a, 'b list>`	p : `ArgumentParser<'a, 'b>` Returns: `ArgumentParser<'a, 'b list>`
`many1 p` Full Usage: `many1 p` Parameters: p : `ArgumentParser<'a, 'b>` Returns: `ArgumentParser<'a, 'b list>`	p : `ArgumentParser<'a, 'b>` Returns: `ArgumentParser<'a, 'b list>`
`mergeMap m1 m2` Full Usage: `mergeMap m1 m2` Parameters: m1 : `Map<'a, 'b>` m2 : `Map<'a, 'b>` Returns: `Map<'a, 'b>`	m1 : `Map<'a, 'b>` m2 : `Map<'a, 'b>` Returns: `Map<'a, 'b>`
`mergeMaps maps` Full Usage: `mergeMaps maps` Parameters: maps : `seq<Map<'a, 'b>>` Returns: `Map<'a, 'b>`	maps : `seq<Map<'a, 'b>>` Returns: `Map<'a, 'b>`
`multipleSaveInMap f` Full Usage: `multipleSaveInMap f` Parameters: f : `'a -> 'b` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	f : `'a -> 'b` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`pLongFlag flag` Full Usage: `pLongFlag flag` Parameters: flag : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	flag : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`pOption includeShort o'` Full Usage: `pOption includeShort o'` Parameters: includeShort : `bool` o' : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	includeShort : `bool` o' : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`pOptions allowMissing flags` Full Usage: `pOptions allowMissing flags` Parameters: allowMissing : `bool` flags : `SafeOptions` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	allowMissing : `bool` flags : `SafeOptions` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`pShortFlag flag` Full Usage: `pShortFlag flag` Parameters: flag : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	flag : `SafeOption` Returns: `IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`parg argName` Full Usage: `parg argName` Parameters: argName : `string` Returns: `IArgumentStream<'a> -> Reply<string>`	argName : `string` Returns: `IArgumentStream<'a> -> Reply<string>`
`pcmd cmd` Full Usage: `pcmd cmd` Parameters: cmd : `string` Returns: `IArgumentStream<'a> -> Reply<string>`	cmd : `string` Returns: `IArgumentStream<'a> -> Reply<string>`
`preturn x stream` Full Usage: `preturn x stream` Parameters: x : `'a` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`	x : `'a` stream : `IArgumentStream<'b>` Returns: `Reply<'a>`
`pseq ps` Full Usage: `pseq ps` Parameters: ps : `seq<ArgumentParser<'a, Map<'b, 'c>>>` Returns: `ArgumentParser<'a, Map<'b, 'c>>`	ps : `seq<ArgumentParser<'a, Map<'b, 'c>>>` Returns: `ArgumentParser<'a, Map<'b, 'c>>`
`punorderedseq allowEmpty allowMissing ps` Full Usage: `punorderedseq allowEmpty allowMissing ps` Parameters: allowEmpty : `bool` allowMissing : `bool` ps : `seq<ArgumentParser<'u, 'a>>` Returns: `ArgumentParser<'u, 'a list>`	allowEmpty : `bool` allowMissing : `bool` ps : `seq<ArgumentParser<'u, 'a>>` Returns: `ArgumentParser<'u, 'a list>`
`punorderedseqWithMany allowEmpty allowMissing ps stream` Full Usage: `punorderedseqWithMany allowEmpty allowMissing ps stream` Parameters: allowEmpty : `bool` allowMissing : `bool` ps : `seq<bool * ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a list>`	allowEmpty : `bool` allowMissing : `bool` ps : `seq<bool * ArgumentParser<'u, 'a>>` stream : `IArgumentStream<'u>` Returns: `Reply<'a list>`
`pzero stream` Full Usage: `pzero stream` Parameters: stream : `IArgumentStream<'a>` Returns: `Reply<'b>`	stream : `IArgumentStream<'a>` Returns: `Reply<'b>`
`saveInMap key f` Full Usage: `saveInMap key f` Parameters: key : `string` f : `'a -> DocoptResult` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	key : `string` f : `'a -> DocoptResult` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`saveInMapM keys f` Full Usage: `saveInMapM keys f` Parameters: keys : `seq<string>` f : `'a -> DocoptResult` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`	keys : `seq<string>` f : `'a -> DocoptResult` Returns: `'a -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>`
`updateMap key newItem map` Full Usage: `updateMap key newItem map` Parameters: key : `string` newItem : `DocoptResult` map : `Map<string, DocoptResult>` Returns: `Map<string, DocoptResult>`	key : `string` newItem : `DocoptResult` map : `Map<string, DocoptResult>` Returns: `Map<string, DocoptResult>`
`updateUserState map' arg' stream'` Full Usage: `updateUserState map' arg' stream'` Parameters: map' : `'a -> DocoptMap -> DocoptMap` arg' : `'a` stream' : `IArgumentStream<DocoptMap>` Returns: `Reply<DocoptMap>`	map' : `'a -> DocoptMap -> DocoptMap` arg' : `'a` stream' : `IArgumentStream<DocoptMap>` Returns: `Reply<DocoptMap>`