#flag

struct Set

pub struct Set {
    pub name string
    pub names []string
    pub kinds []int
    pub bs []bool
    pub ss []string
    pub ins []int
    pub fs []f64
    pub durs []int
    pub usages []string
    pub set_flags []bool
    pub rest []string
    pub parsed bool
}

Purpose

Public struct `Set`.

Parameters

name string

name

names []string

field ([]string)

kinds []int

field ([]int)

bs []bool

field ([]bool)

ss []string

field ([]string)

ins []int

field ([]int)

fs []f64

field ([]f64)

durs []int

field ([]int)

usages []string

field ([]string)

set_flags []bool

field ([]bool)

rest []string

field ([]string)

parsed bool

field (bool)

new_set

pub fn new_set(name string) Set

Purpose

Construct set.

Parameters

name string

name (string)

Returns

Set — a value of this type

(&mut Set) define_bool

pub fn (s &mut Set) define_bool(name string, def bool, usage string)

Purpose

Method on `&mut Set`: define bool.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

def bool

default (bool)

usage string

usage text (string)

(&mut Set) define_string

pub fn (s &mut Set) define_string(name string, def string, usage string)

Purpose

Method on `&mut Set`: define string.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

def string

default (string)

usage string

usage text (string)

(&mut Set) define_int

pub fn (s &mut Set) define_int(name string, def int, usage string)

Purpose

Method on `&mut Set`: define int.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

def int

default (int)

usage string

usage text (string)

(&mut Set) define_float64

pub fn (s &mut Set) define_float64(name string, def f64, usage string)

Purpose

Method on `&mut Set`: define float64.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

def f64

default (f64)

usage string

usage text (string)

(&mut Set) define_duration

pub fn (s &mut Set) define_duration(name string, def int, usage string)

Purpose

Method on `&mut Set`: define duration.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

def int

default (int)

usage string

usage text (string)

(Set) is_set

pub fn (s Set) is_set(name string) bool

Purpose

Method on `Set`: whether it is set.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

bool — true or false

(Set) get_bool

pub fn (s Set) get_bool(name string) bool

Purpose

Method on `Set`: read bool.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

bool — true or false

(Set) get_string

pub fn (s Set) get_string(name string) string

Purpose

Method on `Set`: read string.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

string — result string

(Set) get_int

pub fn (s Set) get_int(name string) int

Purpose

Method on `Set`: read int.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

int — a value of this type

(Set) get_float64

pub fn (s Set) get_float64(name string) f64

Purpose

Method on `Set`: read float64.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

f64 — a value of this type

(Set) get_duration

pub fn (s Set) get_duration(name string) int

Purpose

Method on `Set`: read duration.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

int — a value of this type

(Set) print_defaults

pub fn (s Set) print_defaults()

Purpose

Method on `Set`: print defaults.

Parameters

s Set

receiver Set (value receiver)

(Set) args

pub fn (s Set) args() []string

Purpose

Call `args` on `Set`.

Parameters

s Set

receiver Set (value receiver)

Returns

[]string — slice result

(&mut Set) parse

pub fn (s &mut Set) parse(args []string) int

Purpose

parse consumes args ( FlagSet.Parse shape); returns 0 on success. Positional arguments are kept in the set. May >> errors.Error. Throws on failure.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

args []string

variadic arguments ([]string)

Returns

int — a value of this type

(Set) nflag

pub fn (s Set) nflag() int

Purpose

Call `nflag` on `Set`.

Parameters

s Set

receiver Set (value receiver)

Returns

int — a value of this type

(&mut Set) set

pub fn (s &mut Set) set(name string, value string) int

Purpose

Call `set` on `&mut Set`. Throws on failure.

Parameters

s &mut Set

receiver &mut Set (exclusive borrow)

name string

name (string)

value string

value (string)

Returns

int — a value of this type

(Set) visit

pub fn (s Set) visit() []string

Purpose

Call `visit` on `Set`.

Parameters

s Set

receiver Set (value receiver)

Returns

[]string — slice result

struct Flag

pub struct Flag {
    pub name string
    pub usage string
    pub is_set bool
    pub found bool
}

Purpose

Public struct `Flag`.

Parameters

name string

name

usage string

usage text

is_set bool

field (bool)

found bool

field (bool)

(Set) lookup

pub fn (s Set) lookup(name string) Flag

Purpose

Method on `Set`: lookup.

Parameters

s Set

receiver Set (value receiver)

name string

name (string)

Returns

Flag — a value of this type

(Set) narg

pub fn (s Set) narg() int

Purpose

Call `narg` on `Set`.

Parameters

s Set

receiver Set (value receiver)

Returns

int — a value of this type

(Set) parsed

pub fn (s Set) parsed() bool

Purpose

Call `parsed` on `Set`.

Parameters

s Set

receiver Set (value receiver)

Returns

bool — true or false

(Set) arg

pub fn (s Set) arg(i int) string

Purpose

Call `arg` on `Set`.

Parameters

s Set

receiver Set (value receiver)

i int

index or integer (int)

Returns

string — result string

(Set) visit_all

pub fn (s Set) visit_all() []string

Purpose

Method on `Set`: visit all.

Parameters

s Set

receiver Set (value receiver)

Returns

[]string — slice result