Global

Location

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

Arg

class method Arg(i: int): string

static string Arg(int i)

static func Arg(_ i: int) -> string

func Arg(i int) string

Parameters:

Args

class method Args: Slice<string>

static Slice<string> Args()

static func Args() -> Slice<string>

func Args() Slice<string>

Bool

class method Bool(name: string; value: bool; usage: string): Reference<Boolean>

static Reference<Boolean> Bool(string name, bool value, string usage)

static func Bool(_ name: string, _ value: bool, _ usage: string) -> Reference<Boolean>

func Bool(name string, value bool, usage string) Reference<Boolean>

Parameters:

name:
value:
usage:

BoolVar

class method BoolVar(p: Reference<Boolean>; name: string; value: bool; usage: string)

static void BoolVar(Reference<Boolean> p, string name, bool value, string usage)

static func BoolVar(_ p: Reference<Boolean>, _ name: string, _ value: bool, _ usage: string)

func BoolVar(p Reference<Boolean>, name string, value bool, usage string)

Parameters:

p:
name:
value:
usage:

CommandLine

class var CommandLine: Reference<FlagSet>;

static Reference<FlagSet> CommandLine

static var CommandLine: Reference<FlagSet>

CommandLine Reference<FlagSet>

ContinueOnError

const ContinueOnError: ErrorHandling = 0;

const ErrorHandling ContinueOnError = 0

static let ContinueOnError: ErrorHandling = 0

const ContinueOnError ErrorHandling =  = 0

Duration

class method Duration(name: string; value: Duration; usage: string): Reference<Duration>

static Reference<Duration> Duration(string name, Duration value, string usage)

static func Duration(_ name: string, _ value: Duration, _ usage: string) -> Reference<Duration>

func Duration(name string, value Duration, usage string) Reference<Duration>

Parameters:

name:
value:
usage:

DurationVar

class method DurationVar(p: Reference<Duration>; name: string; value: Duration; usage: string)

static void DurationVar(Reference<Duration> p, string name, Duration value, string usage)

static func DurationVar(_ p: Reference<Duration>, _ name: string, _ value: Duration, _ usage: string)

func DurationVar(p Reference<Duration>, name string, value Duration, usage string)

Parameters:

p:
name:
value:
usage:

ErrHelp

class var ErrHelp: error;

static error ErrHelp

static var ErrHelp: error

ErrHelp error

ExitOnError

const ExitOnError: ErrorHandling = 1;

const ErrorHandling ExitOnError = 1

static let ExitOnError: ErrorHandling = 1

const ExitOnError ErrorHandling =  = 1

Float64

class method Float64(name: string; value: float64; usage: string): Reference<Double>

static Reference<Double> Float64(string name, float64 value, string usage)

static func Float64(_ name: string, _ value: float64, _ usage: string) -> Reference<Double>

func Float64(name string, value float64, usage string) Reference<Double>

Parameters:

name:
value:
usage:

Float64Var

class method Float64Var(p: Reference<Double>; name: string; value: float64; usage: string)

static void Float64Var(Reference<Double> p, string name, float64 value, string usage)

static func Float64Var(_ p: Reference<Double>, _ name: string, _ value: float64, _ usage: string)

func Float64Var(p Reference<Double>, name string, value float64, usage string)

Parameters:

p:
name:
value:
usage:

Int

class method Int(name: string; value: int; usage: string): Reference<Int64>

static Reference<Int64> Int(string name, int value, string usage)

static func Int(_ name: string, _ value: int, _ usage: string) -> Reference<Int64>

func Int(name string, value int, usage string) Reference<Int64>

Parameters:

name:
value:
usage:

Int64

class method Int64(name: string; value: int64; usage: string): Reference<int64>

static Reference<int64> Int64(string name, int64 value, string usage)

static func Int64(_ name: string, _ value: int64, _ usage: string) -> Reference<int64>

func Int64(name string, value int64, usage string) Reference<int64>

Parameters:

name:
value:
usage:

Int64Var

class method Int64Var(p: Reference<int64>; name: string; value: int64; usage: string)

static void Int64Var(Reference<int64> p, string name, int64 value, string usage)

static func Int64Var(_ p: Reference<int64>, _ name: string, _ value: int64, _ usage: string)

func Int64Var(p Reference<int64>, name string, value int64, usage string)

Parameters:

p:
name:
value:
usage:

IntVar

class method IntVar(p: Reference<Int64>; name: string; value: int; usage: string)

static void IntVar(Reference<Int64> p, string name, int value, string usage)

static func IntVar(_ p: Reference<Int64>, _ name: string, _ value: int, _ usage: string)

func IntVar(p Reference<Int64>, name string, value int, usage string)

Parameters:

p:
name:
value:
usage:

Lookup

class method Lookup(name: string): Reference<Flag>

static Reference<Flag> Lookup(string name)

static func Lookup(_ name: string) -> Reference<Flag>

func Lookup(name string) Reference<Flag>

Parameters:

name:

NArg

class method NArg: int

static int NArg()

static func NArg() -> int

func NArg() int

NewFlagSet

class method NewFlagSet(name: string; errorHandling: ErrorHandling): Reference<FlagSet>

static Reference<FlagSet> NewFlagSet(string name, ErrorHandling errorHandling)

static func NewFlagSet(_ name: string, _ errorHandling: ErrorHandling) -> Reference<FlagSet>

func NewFlagSet(name string, errorHandling ErrorHandling) Reference<FlagSet>

Parameters:

name:
errorHandling:

NFlag

class method NFlag: int

static int NFlag()

static func NFlag() -> int

func NFlag() int

PanicOnError

const PanicOnError: ErrorHandling = 2;

const ErrorHandling PanicOnError = 2

static let PanicOnError: ErrorHandling = 2

const PanicOnError ErrorHandling =  = 2

Parse

class method Parse

static void Parse()

static func Parse()

func Parse()

Parsed

class method Parsed: bool

static bool Parsed()

static func Parsed() -> bool

func Parsed() bool

PrintDefaults

class method PrintDefaults

static void PrintDefaults()

static func PrintDefaults()

func PrintDefaults()

Set

class method Set(name: string; value: string): error

static error Set(string name, string value)

static func Set(_ name: string, _ value: string) -> error

func Set(name string, value string) error

Parameters:

name:
value:

String

class method String(name: string; value: string; usage: string): Reference<string>

static Reference<string> String(string name, string value, string usage)

static func String(_ name: string, _ value: string, _ usage: string) -> Reference<string>

func String(name string, value string, usage string) Reference<string>

Parameters:

name:
value:
usage:

StringVar

class method StringVar(p: Reference<string>; name: string; value: string; usage: string)

static void StringVar(Reference<string> p, string name, string value, string usage)

static func StringVar(_ p: Reference<string>, _ name: string, _ value: string, _ usage: string)

func StringVar(p Reference<string>, name string, value string, usage string)

Parameters:

p:
name:
value:
usage:

Uint

class method Uint(name: string; value: uint; usage: string): Reference<UInt64>

static Reference<UInt64> Uint(string name, uint value, string usage)

static func Uint(_ name: string, _ value: uint, _ usage: string) -> Reference<UInt64>

func Uint(name string, value uint, usage string) Reference<UInt64>

Parameters:

name:
value:
usage:

Uint64

class method Uint64(name: string; value: uint64; usage: string): Reference<uint64>

static Reference<uint64> Uint64(string name, uint64 value, string usage)

static func Uint64(_ name: string, _ value: uint64, _ usage: string) -> Reference<uint64>

func Uint64(name string, value uint64, usage string) Reference<uint64>

Parameters:

name:
value:
usage:

Uint64Var

class method Uint64Var(p: Reference<uint64>; name: string; value: uint64; usage: string)

static void Uint64Var(Reference<uint64> p, string name, uint64 value, string usage)

static func Uint64Var(_ p: Reference<uint64>, _ name: string, _ value: uint64, _ usage: string)

func Uint64Var(p Reference<uint64>, name string, value uint64, usage string)

Parameters:

p:
name:
value:
usage:

UintVar

class method UintVar(p: Reference<UInt64>; name: string; value: uint; usage: string)

static void UintVar(Reference<UInt64> p, string name, uint value, string usage)

static func UintVar(_ p: Reference<UInt64>, _ name: string, _ value: uint, _ usage: string)

func UintVar(p Reference<UInt64>, name string, value uint, usage string)

Parameters:

p:
name:
value:
usage:

UnquoteUsage

class method UnquoteUsage(flag: Reference<Flag>): tuple of (name: string, usage: string)

static (string name, string usage) UnquoteUsage(Reference<Flag> flag)

static func UnquoteUsage(_ flag: Reference<Flag>) -> (name:string, usage:string)

func UnquoteUsage(flag Reference<Flag>) (name string, usage string)

Parameters:

flag:

Usage

// .NET, .NET Standard 2.0
class var Usage: $Delegate`0;
// Island
class var Usage: $Delegate;

// .NET, .NET Standard 2.0
static $Delegate`0 Usage
// Island
static $Delegate Usage

// .NET, .NET Standard 2.0
static var Usage: $Delegate`0
// Island
static var Usage: $Delegate

// .NET, .NET Standard 2.0
Usage $Delegate`0
// Island
Usage $Delegate

Var

class method Var(value: Value; name: string; usage: string)

static void Var(Value value, string name, string usage)

static func Var(_ value: Value, _ name: string, _ usage: string)

func Var(value Value, name string, usage string)

Parameters:

value:
name:
usage:

Visit

class method Visit(fn: $Delegate_arg0$_<Reference<Flag>>)

static void Visit($Delegate_arg0$_<Reference<Flag>> fn)

static func Visit(_ fn: $Delegate_arg0$_<Reference<Flag>>)

func Visit(fn $Delegate_arg0$_<Reference<Flag>>)

Parameters:

VisitAll

class method VisitAll(fn: $Delegate_arg0$_<Reference<Flag>>)

static void VisitAll($Delegate_arg0$_<Reference<Flag>> fn)

static func VisitAll(_ fn: $Delegate_arg0$_<Reference<Flag>>)

func VisitAll(fn $Delegate_arg0$_<Reference<Flag>>)

Parameters:

ContinueOnError

const ContinueOnError: ErrorHandling = 0;

const ErrorHandling ContinueOnError = 0

static let ContinueOnError: ErrorHandling = 0

const ContinueOnError ErrorHandling =  = 0

ExitOnError

const ExitOnError: ErrorHandling = 1;

const ErrorHandling ExitOnError = 1

static let ExitOnError: ErrorHandling = 1

const ExitOnError ErrorHandling =  = 1

PanicOnError

const PanicOnError: ErrorHandling = 2;

const ErrorHandling PanicOnError = 2

static let PanicOnError: ErrorHandling = 2

const PanicOnError ErrorHandling =  = 2

CommandLine

class var CommandLine: Reference<FlagSet>;

static Reference<FlagSet> CommandLine

static var CommandLine: Reference<FlagSet>

CommandLine Reference<FlagSet>

ErrHelp

class var ErrHelp: error;

static error ErrHelp

static var ErrHelp: error

ErrHelp error

Usage

// .NET, .NET Standard 2.0
class var Usage: $Delegate`0;
// Island
class var Usage: $Delegate;

// .NET, .NET Standard 2.0
static $Delegate`0 Usage
// Island
static $Delegate Usage

// .NET, .NET Standard 2.0
static var Usage: $Delegate`0
// Island
static var Usage: $Delegate

// .NET, .NET Standard 2.0
Usage $Delegate`0
// Island
Usage $Delegate

Arg

class method Arg(i: int): string

static string Arg(int i)

static func Arg(_ i: int) -> string

func Arg(i int) string

Parameters:

Args

class method Args: Slice<string>

static Slice<string> Args()

static func Args() -> Slice<string>

func Args() Slice<string>

Bool

class method Bool(name: string; value: bool; usage: string): Reference<Boolean>

static Reference<Boolean> Bool(string name, bool value, string usage)

static func Bool(_ name: string, _ value: bool, _ usage: string) -> Reference<Boolean>

func Bool(name string, value bool, usage string) Reference<Boolean>

Parameters:

name:
value:
usage:

BoolVar

class method BoolVar(p: Reference<Boolean>; name: string; value: bool; usage: string)

static void BoolVar(Reference<Boolean> p, string name, bool value, string usage)

static func BoolVar(_ p: Reference<Boolean>, _ name: string, _ value: bool, _ usage: string)

func BoolVar(p Reference<Boolean>, name string, value bool, usage string)

Parameters:

p:
name:
value:
usage:

Duration

class method Duration(name: string; value: Duration; usage: string): Reference<Duration>

static Reference<Duration> Duration(string name, Duration value, string usage)

static func Duration(_ name: string, _ value: Duration, _ usage: string) -> Reference<Duration>

func Duration(name string, value Duration, usage string) Reference<Duration>

Parameters:

name:
value:
usage:

DurationVar

class method DurationVar(p: Reference<Duration>; name: string; value: Duration; usage: string)

static void DurationVar(Reference<Duration> p, string name, Duration value, string usage)

static func DurationVar(_ p: Reference<Duration>, _ name: string, _ value: Duration, _ usage: string)

func DurationVar(p Reference<Duration>, name string, value Duration, usage string)

Parameters:

p:
name:
value:
usage:

Float64

class method Float64(name: string; value: float64; usage: string): Reference<Double>

static Reference<Double> Float64(string name, float64 value, string usage)

static func Float64(_ name: string, _ value: float64, _ usage: string) -> Reference<Double>

func Float64(name string, value float64, usage string) Reference<Double>

Parameters:

name:
value:
usage:

Float64Var

class method Float64Var(p: Reference<Double>; name: string; value: float64; usage: string)

static void Float64Var(Reference<Double> p, string name, float64 value, string usage)

static func Float64Var(_ p: Reference<Double>, _ name: string, _ value: float64, _ usage: string)

func Float64Var(p Reference<Double>, name string, value float64, usage string)

Parameters:

p:
name:
value:
usage:

Int

class method Int(name: string; value: int; usage: string): Reference<Int64>

static Reference<Int64> Int(string name, int value, string usage)

static func Int(_ name: string, _ value: int, _ usage: string) -> Reference<Int64>

func Int(name string, value int, usage string) Reference<Int64>

Parameters:

name:
value:
usage:

Int64

class method Int64(name: string; value: int64; usage: string): Reference<int64>

static Reference<int64> Int64(string name, int64 value, string usage)

static func Int64(_ name: string, _ value: int64, _ usage: string) -> Reference<int64>

func Int64(name string, value int64, usage string) Reference<int64>

Parameters:

name:
value:
usage:

Int64Var

class method Int64Var(p: Reference<int64>; name: string; value: int64; usage: string)

static void Int64Var(Reference<int64> p, string name, int64 value, string usage)

static func Int64Var(_ p: Reference<int64>, _ name: string, _ value: int64, _ usage: string)

func Int64Var(p Reference<int64>, name string, value int64, usage string)

Parameters:

p:
name:
value:
usage:

IntVar

class method IntVar(p: Reference<Int64>; name: string; value: int; usage: string)

static void IntVar(Reference<Int64> p, string name, int value, string usage)

static func IntVar(_ p: Reference<Int64>, _ name: string, _ value: int, _ usage: string)

func IntVar(p Reference<Int64>, name string, value int, usage string)

Parameters:

p:
name:
value:
usage:

Lookup

class method Lookup(name: string): Reference<Flag>

static Reference<Flag> Lookup(string name)

static func Lookup(_ name: string) -> Reference<Flag>

func Lookup(name string) Reference<Flag>

Parameters:

name:

NArg

class method NArg: int

static int NArg()

static func NArg() -> int

func NArg() int

NewFlagSet

class method NewFlagSet(name: string; errorHandling: ErrorHandling): Reference<FlagSet>

static Reference<FlagSet> NewFlagSet(string name, ErrorHandling errorHandling)

static func NewFlagSet(_ name: string, _ errorHandling: ErrorHandling) -> Reference<FlagSet>

func NewFlagSet(name string, errorHandling ErrorHandling) Reference<FlagSet>

Parameters:

name:
errorHandling:

NFlag

class method NFlag: int

static int NFlag()

static func NFlag() -> int

func NFlag() int

Parse

class method Parse

static void Parse()

static func Parse()

func Parse()

Parsed

class method Parsed: bool

static bool Parsed()

static func Parsed() -> bool

func Parsed() bool

PrintDefaults

class method PrintDefaults

static void PrintDefaults()

static func PrintDefaults()

func PrintDefaults()

Set

class method Set(name: string; value: string): error

static error Set(string name, string value)

static func Set(_ name: string, _ value: string) -> error

func Set(name string, value string) error

Parameters:

name:
value:

String

class method String(name: string; value: string; usage: string): Reference<string>

static Reference<string> String(string name, string value, string usage)

static func String(_ name: string, _ value: string, _ usage: string) -> Reference<string>

func String(name string, value string, usage string) Reference<string>

Parameters:

name:
value:
usage:

StringVar

class method StringVar(p: Reference<string>; name: string; value: string; usage: string)

static void StringVar(Reference<string> p, string name, string value, string usage)

static func StringVar(_ p: Reference<string>, _ name: string, _ value: string, _ usage: string)

func StringVar(p Reference<string>, name string, value string, usage string)

Parameters:

p:
name:
value:
usage:

Uint

class method Uint(name: string; value: uint; usage: string): Reference<UInt64>

static Reference<UInt64> Uint(string name, uint value, string usage)

static func Uint(_ name: string, _ value: uint, _ usage: string) -> Reference<UInt64>

func Uint(name string, value uint, usage string) Reference<UInt64>

Parameters:

name:
value:
usage:

Uint64

class method Uint64(name: string; value: uint64; usage: string): Reference<uint64>

static Reference<uint64> Uint64(string name, uint64 value, string usage)

static func Uint64(_ name: string, _ value: uint64, _ usage: string) -> Reference<uint64>

func Uint64(name string, value uint64, usage string) Reference<uint64>

Parameters:

name:
value:
usage:

Uint64Var

class method Uint64Var(p: Reference<uint64>; name: string; value: uint64; usage: string)

static void Uint64Var(Reference<uint64> p, string name, uint64 value, string usage)

static func Uint64Var(_ p: Reference<uint64>, _ name: string, _ value: uint64, _ usage: string)

func Uint64Var(p Reference<uint64>, name string, value uint64, usage string)

Parameters:

p:
name:
value:
usage:

UintVar

class method UintVar(p: Reference<UInt64>; name: string; value: uint; usage: string)

static void UintVar(Reference<UInt64> p, string name, uint value, string usage)

static func UintVar(_ p: Reference<UInt64>, _ name: string, _ value: uint, _ usage: string)

func UintVar(p Reference<UInt64>, name string, value uint, usage string)

Parameters:

p:
name:
value:
usage:

UnquoteUsage

class method UnquoteUsage(flag: Reference<Flag>): tuple of (name: string, usage: string)

static (string name, string usage) UnquoteUsage(Reference<Flag> flag)

static func UnquoteUsage(_ flag: Reference<Flag>) -> (name:string, usage:string)

func UnquoteUsage(flag Reference<Flag>) (name string, usage string)

Parameters:

flag:

Var

class method Var(value: Value; name: string; usage: string)

static void Var(Value value, string name, string usage)

static func Var(_ value: Value, _ name: string, _ usage: string)

func Var(value Value, name string, usage string)

Parameters:

value:
name:
usage:

Visit

class method Visit(fn: $Delegate_arg0$_<Reference<Flag>>)

static void Visit($Delegate_arg0$_<Reference<Flag>> fn)

static func Visit(_ fn: $Delegate_arg0$_<Reference<Flag>>)

func Visit(fn $Delegate_arg0$_<Reference<Flag>>)

Parameters:

VisitAll

class method VisitAll(fn: $Delegate_arg0$_<Reference<Flag>>)

static void VisitAll($Delegate_arg0$_<Reference<Flag>> fn)

static func VisitAll(_ fn: $Delegate_arg0$_<Reference<Flag>>)

func VisitAll(fn $Delegate_arg0$_<Reference<Flag>>)

Parameters: