Overview

Location

  • Reference:
    • Go.dll  .NET, .NET Standard 2.0
    • Go.fx  Island
  • Namespace: go.flag
  • Platforms: .NET, .NET Standard 2.0, Island

constructor

// .NET, .NET Standard 2.0
constructor(aUsage: Action; aname: string; aparsed: Boolean; aactual: Map<string, Memory<Flag>>; aformal: Map<string, Memory<Flag>>; aargs: Slice<string>; aerrorHandling: ErrorHandling; aoutput: Writer)
// Island
constructor(aUsage: Action; aname: string; aparsed: bool; aactual: Map<string, Memory<Flag>>; aformal: Map<string, Memory<Flag>>; aargs: Slice<string>; aerrorHandling: ErrorHandling; aoutput: Writer)
// .NET, .NET Standard 2.0
FlagSet(Action aUsage, string aname, Boolean aparsed, Map<string, Memory<Flag>> aactual, Map<string, Memory<Flag>> aformal, Slice<string> aargs, ErrorHandling aerrorHandling, Writer aoutput)
// Island
FlagSet(Action aUsage, string aname, bool aparsed, Map<string, Memory<Flag>> aactual, Map<string, Memory<Flag>> aformal, Slice<string> aargs, ErrorHandling aerrorHandling, Writer aoutput)
// .NET, .NET Standard 2.0
init(_ aUsage: Action, _ aname: string, _ aparsed: Boolean, _ aactual: Map<string, Memory<Flag>>, _ aformal: Map<string, Memory<Flag>>, _ aargs: Slice<string>, _ aerrorHandling: ErrorHandling, _ aoutput: Writer)
// Island
init(_ aUsage: Action, _ aname: string, _ aparsed: bool, _ aactual: Map<string, Memory<Flag>>, _ aformal: Map<string, Memory<Flag>>, _ aargs: Slice<string>, _ aerrorHandling: ErrorHandling, _ aoutput: Writer)
// .NET, .NET Standard 2.0
Sub New(aUsage As Action, aname As string, aparsed As Boolean, aactual As Map<string, Memory<Flag>>, aformal As Map<string, Memory<Flag>>, aargs As Slice<string>, aerrorHandling As ErrorHandling, aoutput As Writer)
// Island
Sub New(aUsage As Action, aname As string, aparsed As bool, aactual As Map<string, Memory<Flag>>, aformal As Map<string, Memory<Flag>>, aargs As Slice<string>, aerrorHandling As ErrorHandling, aoutput As Writer)

Parameters:

  • aUsage:
  • aname:
  • aparsed:
  • aactual:
  • aformal:
  • aargs:
  • aerrorHandling:
  • aoutput: 
constructor(value: FlagSet)
Sub New(value As FlagSet)

Parameters:

  • value:

Arg

method Arg(i: int): string
func Arg(_ i: int) -> string
Function Arg(i As int) As string

Parameters:

  • i:

Args

method Args: Slice<string>
func Args() -> Slice<string>
func Args() Slice<string>
Function Args() As Slice<string>

Bool

method Bool(name: string; value: bool; usage: string): Memory<Boolean>
Memory<Boolean> Bool(string name, bool value, string usage)
func Bool(_ name: string, _ value: bool, _ usage: string) -> Memory<Boolean>
func Bool(name string, value bool, usage string) Memory<Boolean>
Function Bool(name As string, value As bool, usage As string) As Memory<Boolean>

Parameters:

  • name:
  • value:
  • usage:

BoolVar

method BoolVar(p: Memory<Boolean>; name: string; value: bool; usage: string)
void BoolVar(Memory<Boolean> p, string name, bool value, string usage)
func BoolVar(_ p: Memory<Boolean>, _ name: string, _ value: bool, _ usage: string)
// .NET, .NET Standard 2.0
func BoolVar(p Memory<Boolean>, name string, value bool, usage string) 
// Island
func BoolVar(p Memory<Boolean>, name string, value bool, usage string) void
Sub BoolVar(p As Memory<Boolean>, name As string, value As bool, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

Duration

method Duration(name: string; value: Duration; usage: string): Memory<Duration>
Memory<Duration> Duration(string name, Duration value, string usage)
func Duration(_ name: string, _ value: Duration, _ usage: string) -> Memory<Duration>
func Duration(name string, value Duration, usage string) Memory<Duration>
Function Duration(name As string, value As Duration, usage As string) As Memory<Duration>

Parameters:

  • name:
  • value:
  • usage:

DurationVar

method DurationVar(p: Memory<Duration>; name: string; value: Duration; usage: string)
void DurationVar(Memory<Duration> p, string name, Duration value, string usage)
func DurationVar(_ p: Memory<Duration>, _ name: string, _ value: Duration, _ usage: string)
// .NET, .NET Standard 2.0
func DurationVar(p Memory<Duration>, name string, value Duration, usage string) 
// Island
func DurationVar(p Memory<Duration>, name string, value Duration, usage string) void
Sub DurationVar(p As Memory<Duration>, name As string, value As Duration, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

ErrorHandling

method ErrorHandling: ErrorHandling
ErrorHandling ErrorHandling()
func ErrorHandling() -> ErrorHandling
func ErrorHandling() ErrorHandling
Function ErrorHandling() As ErrorHandling

Float64

method Float64(name: string; value: float64; usage: string): Memory<Double>
Memory<Double> Float64(string name, float64 value, string usage)
func Float64(_ name: string, _ value: float64, _ usage: string) -> Memory<Double>
func Float64(name string, value float64, usage string) Memory<Double>
Function Float64(name As string, value As float64, usage As string) As Memory<Double>

Parameters:

  • name:
  • value:
  • usage:

Float64Var

method Float64Var(p: Memory<Double>; name: string; value: float64; usage: string)
void Float64Var(Memory<Double> p, string name, float64 value, string usage)
func Float64Var(_ p: Memory<Double>, _ name: string, _ value: float64, _ usage: string)
// .NET, .NET Standard 2.0
func Float64Var(p Memory<Double>, name string, value float64, usage string) 
// Island
func Float64Var(p Memory<Double>, name string, value float64, usage string) void
Sub Float64Var(p As Memory<Double>, name As string, value As float64, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

Init

method Init(name: string; errorHandling: ErrorHandling)
void Init(string name, ErrorHandling errorHandling)
func Init(_ name: string, _ errorHandling: ErrorHandling)
// .NET, .NET Standard 2.0
func Init(name string, errorHandling ErrorHandling) 
// Island
func Init(name string, errorHandling ErrorHandling) void
Sub Init(name As string, errorHandling As ErrorHandling)

Parameters:

  • name:
  • errorHandling:

Int

method Int(name: string; value: int; usage: string): Memory<Int64>
Memory<Int64> Int(string name, int value, string usage)
func Int(_ name: string, _ value: int, _ usage: string) -> Memory<Int64>
func Int(name string, value int, usage string) Memory<Int64>
Function Int(name As string, value As int, usage As string) As Memory<Int64>

Parameters:

  • name:
  • value:
  • usage:

Int64

method Int64(name: string; value: int64; usage: string): Memory<int64>
Memory<int64> Int64(string name, int64 value, string usage)
func Int64(_ name: string, _ value: int64, _ usage: string) -> Memory<int64>
func Int64(name string, value int64, usage string) Memory<int64>
Function Int64(name As string, value As int64, usage As string) As Memory<int64>

Parameters:

  • name:
  • value:
  • usage:

Int64Var

method Int64Var(p: Memory<int64>; name: string; value: int64; usage: string)
void Int64Var(Memory<int64> p, string name, int64 value, string usage)
func Int64Var(_ p: Memory<int64>, _ name: string, _ value: int64, _ usage: string)
// .NET, .NET Standard 2.0
func Int64Var(p Memory<int64>, name string, value int64, usage string) 
// Island
func Int64Var(p Memory<int64>, name string, value int64, usage string) void
Sub Int64Var(p As Memory<int64>, name As string, value As int64, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

IntVar

method IntVar(p: Memory<Int64>; name: string; value: int; usage: string)
void IntVar(Memory<Int64> p, string name, int value, string usage)
func IntVar(_ p: Memory<Int64>, _ name: string, _ value: int, _ usage: string)
// .NET, .NET Standard 2.0
func IntVar(p Memory<Int64>, name string, value int, usage string) 
// Island
func IntVar(p Memory<Int64>, name string, value int, usage string) void
Sub IntVar(p As Memory<Int64>, name As string, value As int, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

Lookup

method Lookup(name: string): Memory<Flag>
Memory<Flag> Lookup(string name)
func Lookup(_ name: string) -> Memory<Flag>
func Lookup(name string) Memory<Flag>
Function Lookup(name As string) As Memory<Flag>

Parameters:

  • name:

Name

Function Name() As string

NArg

NFlag

Output

Function Output() As Writer

Parse

method Parse(arguments: Slice<string>): error
error Parse(Slice<string> arguments)
func Parse(_ arguments: Slice<string>) -> error
func Parse(arguments Slice<string>) error
Function Parse(arguments As Slice<string>) As error

Parameters:

  • arguments:

Parsed

Function Parsed() As bool

PrintDefaults

// .NET, .NET Standard 2.0
func PrintDefaults() 
// Island
func PrintDefaults() void

Set

method Set(name: string; value: string): error
error Set(string name, string value)
func Set(_ name: string, _ value: string) -> error
func Set(name string, value string) error
Function Set(name As string, value As string) As error

Parameters:

  • name:
  • value:

SetOutput

method SetOutput(output: Writer)
void SetOutput(Writer output)
func SetOutput(_ output: Writer)
// .NET, .NET Standard 2.0
func SetOutput(output Writer) 
// Island
func SetOutput(output Writer) void
Sub SetOutput(output As Writer)

Parameters:

  • output:

String

method String(name: string; value: string; usage: string): Memory<string>
Memory<string> String(string name, string value, string usage)
func String(_ name: string, _ value: string, _ usage: string) -> Memory<string>
func String(name string, value string, usage string) Memory<string>
Function String(name As string, value As string, usage As string) As Memory<string>

Parameters:

  • name:
  • value:
  • usage:

StringVar

method StringVar(p: Memory<string>; name: string; value: string; usage: string)
void StringVar(Memory<string> p, string name, string value, string usage)
func StringVar(_ p: Memory<string>, _ name: string, _ value: string, _ usage: string)
// .NET, .NET Standard 2.0
func StringVar(p Memory<string>, name string, value string, usage string) 
// Island
func StringVar(p Memory<string>, name string, value string, usage string) void
Sub StringVar(p As Memory<string>, name As string, value As string, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

Uint

method Uint(name: string; value: uint; usage: string): Memory<UInt64>
Memory<UInt64> Uint(string name, uint value, string usage)
func Uint(_ name: string, _ value: uint, _ usage: string) -> Memory<UInt64>
func Uint(name string, value uint, usage string) Memory<UInt64>
Function Uint(name As string, value As uint, usage As string) As Memory<UInt64>

Parameters:

  • name:
  • value:
  • usage:

Uint64

method Uint64(name: string; value: uint64; usage: string): Memory<uint64>
Memory<uint64> Uint64(string name, uint64 value, string usage)
func Uint64(_ name: string, _ value: uint64, _ usage: string) -> Memory<uint64>
func Uint64(name string, value uint64, usage string) Memory<uint64>
Function Uint64(name As string, value As uint64, usage As string) As Memory<uint64>

Parameters:

  • name:
  • value:
  • usage:

Uint64Var

method Uint64Var(p: Memory<uint64>; name: string; value: uint64; usage: string)
void Uint64Var(Memory<uint64> p, string name, uint64 value, string usage)
func Uint64Var(_ p: Memory<uint64>, _ name: string, _ value: uint64, _ usage: string)
// .NET, .NET Standard 2.0
func Uint64Var(p Memory<uint64>, name string, value uint64, usage string) 
// Island
func Uint64Var(p Memory<uint64>, name string, value uint64, usage string) void
Sub Uint64Var(p As Memory<uint64>, name As string, value As uint64, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

UintVar

method UintVar(p: Memory<UInt64>; name: string; value: uint; usage: string)
void UintVar(Memory<UInt64> p, string name, uint value, string usage)
func UintVar(_ p: Memory<UInt64>, _ name: string, _ value: uint, _ usage: string)
// .NET, .NET Standard 2.0
func UintVar(p Memory<UInt64>, name string, value uint, usage string) 
// Island
func UintVar(p Memory<UInt64>, name string, value uint, usage string) void
Sub UintVar(p As Memory<UInt64>, name As string, value As uint, usage As string)

Parameters:

  • p:
  • name:
  • value:
  • usage:

Usage

Var

method Var(value: Value; name: string; usage: string)
void Var(Value value, string name, string usage)
func Var(_ value: Value, _ name: string, _ usage: string)
// .NET, .NET Standard 2.0
func Var(value Value, name string, usage string) 
// Island
func Var(value Value, name string, usage string) void
Sub Var(value As Value, name As string, usage As string)

Parameters:

  • value:
  • name:
  • usage:

Visit

method Visit(fn: Action<Memory<Flag>>)
void Visit(Action<Memory<Flag>> fn)
func Visit(_ fn: Action<Memory<Flag>>)
// .NET, .NET Standard 2.0
func Visit(fn Action<Memory<Flag>>) 
// Island
func Visit(fn Action<Memory<Flag>>) void
// .NET, .NET Standard 2.0, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows
Sub Visit(fn As Action<Memory<Flag>>)
// Island-watchOS-armv7k
Sub Visit(fn As Action (Of Memory<Flag>))

Parameters:

  • fn:

VisitAll

method VisitAll(fn: Action<Memory<Flag>>)
void VisitAll(Action<Memory<Flag>> fn)
func VisitAll(_ fn: Action<Memory<Flag>>)
// .NET, .NET Standard 2.0
func VisitAll(fn Action<Memory<Flag>>) 
// Island
func VisitAll(fn Action<Memory<Flag>>) void
// .NET, .NET Standard 2.0, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows
Sub VisitAll(fn As Action<Memory<Flag>>)
// Island-watchOS-armv7k
Sub VisitAll(fn As Action (Of Memory<Flag>))

Parameters:

  • fn:

constructor

// .NET, .NET Standard 2.0
constructor(aUsage: Action; aname: string; aparsed: Boolean; aactual: Map<string, Memory<Flag>>; aformal: Map<string, Memory<Flag>>; aargs: Slice<string>; aerrorHandling: ErrorHandling; aoutput: Writer)
// Island
constructor(aUsage: Action; aname: string; aparsed: bool; aactual: Map<string, Memory<Flag>>; aformal: Map<string, Memory<Flag>>; aargs: Slice<string>; aerrorHandling: ErrorHandling; aoutput: Writer)
// .NET, .NET Standard 2.0
FlagSet(Action aUsage, string aname, Boolean aparsed, Map<string, Memory<Flag>> aactual, Map<string, Memory<Flag>> aformal, Slice<string> aargs, ErrorHandling aerrorHandling, Writer aoutput)
// Island
FlagSet(Action aUsage, string aname, bool aparsed, Map<string, Memory<Flag>> aactual, Map<string, Memory<Flag>> aformal, Slice<string> aargs, ErrorHandling aerrorHandling, Writer aoutput)
// .NET, .NET Standard 2.0
init(_ aUsage: Action, _ aname: string, _ aparsed: Boolean, _ aactual: Map<string, Memory<Flag>>, _ aformal: Map<string, Memory<Flag>>, _ aargs: Slice<string>, _ aerrorHandling: ErrorHandling, _ aoutput: Writer)
// Island
init(_ aUsage: Action, _ aname: string, _ aparsed: bool, _ aactual: Map<string, Memory<Flag>>, _ aformal: Map<string, Memory<Flag>>, _ aargs: Slice<string>, _ aerrorHandling: ErrorHandling, _ aoutput: Writer)
// .NET, .NET Standard 2.0
Sub New(aUsage As Action, aname As string, aparsed As Boolean, aactual As Map<string, Memory<Flag>>, aformal As Map<string, Memory<Flag>>, aargs As Slice<string>, aerrorHandling As ErrorHandling, aoutput As Writer)
// Island
Sub New(aUsage As Action, aname As string, aparsed As bool, aactual As Map<string, Memory<Flag>>, aformal As Map<string, Memory<Flag>>, aargs As Slice<string>, aerrorHandling As ErrorHandling, aoutput As Writer)

Parameters:

  • aUsage:
  • aname:
  • aparsed:
  • aactual:
  • aformal:
  • aargs:
  • aerrorHandling:
  • aoutput: 
constructor(value: FlagSet)
Sub New(value As FlagSet)

Parameters:

  • value: