flags

package
v0.5.31 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2024 License: MIT Imports: 7 Imported by: 0

README

サンプルリスト

このディレクトリには以下のサンプルがあります。

file example name note
flagset.go flags_flagset flag.Flagset のサンプルです
var.go flags_var flag.Var() のサンプルです
int.go flags_int flag.Int(), flag.IntVar() のサンプルです
bool.go flags_bool flag.Bool(), flag.BoolVar() のサンプルです
string.go flags_string flag.String(), flag.StringVar() のサンプルです
duration.go flags_duration flag.Duration(), flag.DurationVar() のサンプルです
func.go flags_func flag.Func() のサンプルです
textvar.go flags_textvar flag.TextVar() のサンプルです
nargs.go flags_nargs flag.Arg(), flag.Args(), flag.NArg(), flag.NFlag() のサンプルです
subcommand.go flags_subcommand flagパッケージを使ってサブコマンドを実現するサンプルです

Documentation

Overview

Package flags -- flag パッケージに関するサンプルが配置されているパッケージです。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool

func Bool() error

Bool は、flag.Bool(), flag.BoolVar() のサンプルです。

flagパッケージの関数は、flag.Bool()のように受け皿を戻り値で返してくれる関数と flag.BoolVar() のように予め自前で用意している変数を利用する2パターンの使い方がある。

REFERENCES

func Duration

func Duration() error

Duration は、flag.Duration(), flag.DurationVar() のサンプルです。

flagパッケージの関数は、flag.Duration()のように受け皿を戻り値で返してくれる関数と flag.DurationVar() のように予め自前で用意している変数を利用する2パターンの使い方がある。

REFERENCES

func Flagset

func Flagset() error

Flagset は、flag.Flagsetのサンプルです。

通常、flagパッケージはアプリケーションの引数を扱うものであるが flag.Flagsetを利用することで、外から引数を指定してパースすることが可能となる。 ユニットテストと相性が良い。

REFERENCES

func Func

func Func() error

Func は、flag.Func() のサンプルです.

flag.Func() は、func(string) error の関数を設定することで 任意の処理を行うことが出来る関数です。

REFERENCES

func Int

func Int() error

Int は、flag.Int(), flag.IntVar() のサンプルです。

flagパッケージの関数は、flag.Int()のように受け皿を戻り値で返してくれる関数と flag.IntVar() のように予め自前で用意している変数を利用する2パターンの使い方がある。

REFERENCES

func Nargs

func Nargs() error

Nargs は、flag.Arg(), flag.Args(), flag.NArg(), flag.NFlag() のサンプルです.

  • flag.NFlag() は、処理したフラグの数
  • flag.NArg() は、処理していない引数の数
  • flag.Arg(i) は、処理していない引数のN番目を取得
  • flag.Args() は、処理していない引数リストを取得

REFERENCES

func NewRegister

func NewRegister() mapping.Register

NewRegister -- このパッケージ用のサンプルを登録する mapping.Register を生成します。

func String

func String() error

String は、flag.String(), flag.StringVar() のサンプルです。

flagパッケージの関数は、flag.String()のように受け皿を戻り値で返してくれる関数と flag.StringVar() のように予め自前で用意している変数を利用する2パターンの使い方がある。

REFERENCES

func Subcommand added in v0.5.25

func Subcommand() error

Subcommand は、flagパッケージを使ってサブコマンドを実現するサンプルです.

flagパッケージを使って、サブコマンドを実現する場合は flag.FlagSetでそれぞれのサブコマンドを表現する。

サブコマンドの数が多い場合や細かな制御などをしたい場合は [flaggy](https://github.com/integrii/flaggy) などの外部ライブラリを利用する方が楽。

flaggyのサンプルについては [try-golang-extlib](https://github.com/devlights/try-golang-extlib/tree/main/examples/singleapp/flaggy) を参照。

REFERENCES

func TextVar

func TextVar() error

TextVar は、 flag.TextVar() のサンプルです.

flag.TextVar() は、Go 1.19 で追加された関数です。 encoding.TextUnmarshaler を実装している型を指定出来ます。

encoding.TextUnmarshaler を実装しているものとして以下のものがあります。

  • time.Time
  • net.IP
  • url.URL

REFERENCES

func Var

func Var() error

Var は、flag.Var() のサンプルです。

flag.Var() には、任意の値をフラグハンドリングのための値として指定出来ます。 条件として、flag.Valueインターフェースを実装している必要があります。

REFERENCES

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL