API
#flag
Xu 0.8.8 API
import: #flag
counts: 1 函数, 22 方法, 2 类型, 0 常量, 0 方法集
FlagSet，无全局状态：define_* + parse + print_defaults。
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
}
用途
公开结构体 `Set`。
参数
name string- 名字
names []string- 字段（[]string）
kinds []int- 字段（[]int）
bs []bool- 字段（[]bool）
ss []string- 字段（[]string）
ins []int- 字段（[]int）
fs []f64- 字段（[]f64）
durs []int- 字段（[]int）
usages []string- 字段（[]string）
set_flags []bool- 字段（[]bool）
rest []string- 字段（[]string）
parsed bool- 字段（bool）
new_set
pub fn new_set(name string) Set
用途
构造 set。
参数
name string- 名字（string）
返回
Set — 该类型的值
(&mut Set) define_bool
pub fn (s &mut Set) define_bool(name string, def bool, usage string)
用途
`&mut Set` 上的方法：definebool。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
def bool- 默认值（bool）
usage string- 用法说明（string）
(&mut Set) define_string
pub fn (s &mut Set) define_string(name string, def string, usage string)
用途
`&mut Set` 上的方法：define字符串。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
def string- 默认值（string）
usage string- 用法说明（string）
(&mut Set) define_int
pub fn (s &mut Set) define_int(name string, def int, usage string)
用途
`&mut Set` 上的方法：defineint。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
def int- 默认值（int）
usage string- 用法说明（string）
(&mut Set) define_float64
pub fn (s &mut Set) define_float64(name string, def f64, usage string)
用途
`&mut Set` 上的方法：definefloat64。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
def f64- 默认值（f64）
usage string- 用法说明（string）
(&mut Set) define_duration
pub fn (s &mut Set) define_duration(name string, def int, usage string)
用途
`&mut Set` 上的方法：defineduration。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
def int- 默认值（int）
usage string- 用法说明（string）
(Set) is_set
pub fn (s Set) is_set(name string) bool
用途
`Set` 上的方法：判断是否 set。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
bool — 是否成立
(Set) get_bool
pub fn (s Set) get_bool(name string) bool
用途
`Set` 上的方法：读取 bool。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
bool — 是否成立
(Set) get_string
pub fn (s Set) get_string(name string) string
用途
`Set` 上的方法：读取 string。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
string — 结果字符串
(Set) get_int
pub fn (s Set) get_int(name string) int
用途
`Set` 上的方法：读取 int。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
int — 该类型的值
(Set) get_float64
pub fn (s Set) get_float64(name string) f64
用途
`Set` 上的方法：读取 float64。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
f64 — 该类型的值
(Set) get_duration
pub fn (s Set) get_duration(name string) int
用途
`Set` 上的方法：读取 duration。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
int — 该类型的值
(Set) print_defaults
pub fn (s Set) print_defaults()
用途
`Set` 上的方法：打印defaults。
参数
s Set- 接收者 Set（值接收者）
(Set) args
pub fn (s Set) args() []string
用途
在 `Set` 上调用 `args`。
参数
s Set- 接收者 Set（值接收者）
返回
[]string — 切片结果
(&mut Set) parse
pub fn (s &mut Set) parse(args []string) int
用途
`&mut Set` 上的方法：解析输入。失败时 throw。
参数
s &mut Set- 接收者 &mut Set（可变借用）
args []string- 可变实参（[]string）
返回
int — 该类型的值
(Set) nflag
pub fn (s Set) nflag() int
用途
在 `Set` 上调用 `nflag`。
参数
s Set- 接收者 Set（值接收者）
返回
int — 该类型的值
(&mut Set) set
pub fn (s &mut Set) set(name string, value string) int
用途
在 `&mut Set` 上调用 `set`。失败时 throw。
参数
s &mut Set- 接收者 &mut Set（可变借用）
name string- 名字（string）
value string- value（string）
返回
int — 该类型的值
(Set) visit
pub fn (s Set) visit() []string
用途
`Set` 上的方法：访问。
参数
s Set- 接收者 Set（值接收者）
返回
[]string — 切片结果
struct Flag
pub struct Flag {
pub name string
pub usage string
pub is_set bool
pub found bool
}
用途
公开结构体 `Flag`。
参数
name string- 名字
usage string- 用法说明
is_set bool- 字段（bool）
found bool- 字段（bool）
(Set) lookup
pub fn (s Set) lookup(name string) Flag
用途
`Set` 上的方法：查找。
参数
s Set- 接收者 Set（值接收者）
name string- 名字（string）
返回
Flag — 该类型的值
(Set) narg
pub fn (s Set) narg() int
用途
在 `Set` 上调用 `narg`。
参数
s Set- 接收者 Set（值接收者）
返回
int — 该类型的值
(Set) parsed
pub fn (s Set) parsed() bool
用途
在 `Set` 上调用 `parsed`。
参数
s Set- 接收者 Set（值接收者）
返回
bool — 是否成立
(Set) arg
pub fn (s Set) arg(i int) string
用途
在 `Set` 上调用 `arg`。
参数
s Set- 接收者 Set（值接收者）
i int- 下标或整数（int）
返回
string — 结果字符串
(Set) visit_all
pub fn (s Set) visit_all() []string
用途
`Set` 上的方法：访问all。
参数
s Set- 接收者 Set（值接收者）
返回
[]string — 切片结果
