flag

package
v1.26.2 Latest Latest
Warning

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

 Go to latest Published: May 16, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

flagパッケージは、コマンドラインのフラグ解析を実装します。

使用法

flag.String、Bool、Int などを使用してフラグを定義します。

これは、ポインタnFlagに格納された整数フラグ-nを宣言し、型*intを持つものです。 

import "flag"
var nFlag = flag.Int（"n"、1234、"フラグnのヘルプメッセージ"）

好きな場合、Var（）関数を使用してフラグを変数にバインドすることもできます。 

var flagvar int
func init（）{
	flag.IntVar（&flagvar、"flagname"、1234、"フラグ名のヘルプメッセージ"）
}

または、フラグを値インターフェースを満たすカスタムフラグに作成し、次にフラグ解析と結びつけることもできます（ポインタレシーバを使用）。 

flag.Var（&flagVal、「名前」、「flagnameのヘルプメッセージ」）

そのようなフラグの場合、デフォルト値は変数の初期値そのままです。

すべてのフラグが定義された後、次を呼び出して 

flag.Parse（）

定義されたフラグをコマンドラインで解析します。

その後、フラグを直接使用できます。フラグ自体を使用している場合、それらはすべてポインタです。変数にバインドする場合、値です。 

ipの値は、*ipを出力します。
flagvarの値は、flagvarを出力します。

解析後、フラグに続く引数は、スライス flag.Args または個別に flag.Arg(i) として使用できます。 引数は0から flag.NArg-1 までインデックス付けされます。

コマンドラインフラグの句法

次の形式が許可されています。 

-flag
--flag   // ダブルダッシュも許可されています
-flag=x
-flag x  // ブールフラグ以外

1つまたは2つのダッシュを使用できます。それらは同等です。 最後の形式は、0、falseなどという名前のファイルがある場合にはブールフラグでは許可されていません。 

cmd -x *

Unixシェルのワイルドカードである、Starは、「-」のコマンドの意味が変わるため、ブールフラグをオフにするには、-flag=false形式を使用する必要があります。

フラグ解析は、最初の非フラグ引数（「-」は非フラグ引数です）または終端子「--」の直前で停止します。

整数フラグは、1234、0664、0x1234などを受け入れ、負の値にすることもできます。 ブールフラグは以下のどれかです： 

1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False

期間フラグは、time.ParseDurationで有効な入力を受け入れます。

コマンドラインフラグのデフォルトセットは、トップレベルの関数によって制御されます。 FlagSet 型は、コマンドラインインターフェースのサブコマンドを実装するための独立したフラグセットを定義するために使用します。 FlagSet のメソッドは、コマンドラインフラグセットのトップレベルの関数と同様です。

Example 
package main

import ()

func main() {

	// ここには興味深いコードの変数が宣言されますが、
	// それらのフラグをフラグパッケージが見るためには、通常はmainの開始時に実行する必要があります（initではなく）：
	// 	flag.Parse()
	// このコードはパッケージのテストスイートの一部である「Example」と呼ばれる関数であり、
	// すでにフラグが解析されていますので、ここでは呼び出しません。
	// ただし、pkg.go.devで表示される場合、この関数は「main」という名前に変更され、スタンドアロンの例として実行できます。
}

Index

Examples

Constants

This section is empty.

Variables

View Source 
var CommandLine = NewFlagSet(os.Args[0], ExitOnError)

CommandLineは os.Args から解析されたデフォルトのコマンドラインフラグのセットです。 BoolVar、Arg などのトップレベルの関数は、CommandLineのメソッドのラッパーです。

View Source 
var ErrHelp = errors.New("flag: help requested")

ErrHelpは、-helpまたは-hフラグが呼び出されたが、そのようなフラグが定義されていない場合に返されるエラーです。

View Source 
var Usage = func() {
	fmt.Fprintf(CommandLine.Output(), "Usage of %s:\n", os.Args[0])
	PrintDefaults()
}

Usageは、 CommandLine の出力（デフォルトで os.Stderr）に、定義されたすべてのコマンドラインフラグに関する使用法メッセージを出力します。 フラグの解析中にエラーが発生したときに呼び出されます。 この関数はカスタム関数を指すように変更できる変数です。 デフォルトでは、簡単なヘッダーが表示され、PrintDefaults が呼び出されます。 出力のフォーマットや、それを制御する方法の詳細については、PrintDefaults のドキュメントを参照してください。 カスタムのUsage関数ではプログラムを終了することも選択できますが、デフォルトでは終了は常に発生します。 なぜなら、コマンドラインのエラーハンドリングストラテジーは ExitOnError に設定されているからです。

Functions

func Arg 

func Arg(i int) string

Argはi番目のコマンドライン引数を返します。Arg(0)は、フラグが処理された後の最初の残りの引数です。要求された要素が存在しない場合、Argは空の文字列を返します。

func Args 

func Args() []string

Argsはフラグではないコマンドライン引数を返します。

func Bool 

func Bool(name string, value bool, usage string) *bool

Boolは指定された名前、デフォルト値、使用方法の文字列を持つboolフラグを定義します。 返り値はフラグの値を格納するbool変数のアドレスです。

func BoolFunc added in v1.21.0 

func BoolFunc(name, usage string, fn func(string) error)

BoolFuncは値を必要とせず、指定した名前と使用方法のフラグを定義します。 フラグが表示されるたびに、fnがフラグの値で呼び出されます。 もしfnが非nilのエラーを返した場合、それはフラグの値のパースエラーとして扱われます。

Example 
package main

import (
	"github.com/shogo82148/std/flag"
	"github.com/shogo82148/std/fmt"
	"github.com/shogo82148/std/os"
)

func main() {
	fs := flag.NewFlagSet("ExampleBoolFunc", flag.ContinueOnError)
	fs.SetOutput(os.Stdout)

	fs.BoolFunc("log", "logs a dummy message", func(s string) error {
		fmt.Println("dummy message:", s)
		return nil
	})
	fs.Parse([]string{"-log"})
	fs.Parse([]string{"-log=0"})

}

Output:
dummy message: true
dummy message: 0

func BoolVar 

func BoolVar(p *bool, name string, value bool, usage string)

BoolVarは指定された名前、デフォルト値、および使用方法のあるboolフラグを定義します。 引数pは、フラグの値を格納するbool変数を指すポインタです。

func Duration 

func Duration(name string, value time.Duration, usage string) *time.Duration

Durationは指定された名前、デフォルト値、および使用法の文字列を持つtime.Durationフラグを定義します。 戻り値は、flagの値を格納するtime.Duration変数のアドレスです。 このフラグは、time.ParseDurationで受け入れ可能な値を受け入れます。

func DurationVar 

func DurationVar(p *time.Duration, name string, value time.Duration, usage string)

DurationVarは、指定された名前、デフォルト値、使用方法の文字列を持つtime.Durationフラグを定義します。 引数pは、フラグの値を格納するためのtime.Duration変数を指すポインタです。 フラグはtime.ParseDurationで受け入れ可能な値を受け付けます。

func Float64 

func Float64(name string, value float64, usage string) *float64

Float64は指定された名前、デフォルト値、および使用法の文字列を持つfloat64フラグを定義します。 戻り値は、フラグの値を格納するfloat64変数のアドレスです。

func Float64Var 

func Float64Var(p *float64, name string, value float64, usage string)

Float64Varは指定された名前、デフォルト値、使用法の文字列を持つfloat64フラグを定義します。 引数pはフラグの値を保存するためのfloat64変数を指すポインタです。

func Func added in v1.16.0 

func Func(name, usage string, fn func(string) error)

Funcは指定された名前と使用法の文字列を持つフラグを定義します。 フラグが見つかるたびに、fnがフラグの値で呼び出されます。 もしfnが非nilのエラーを返す場合、それはフラグ値の解析エラーとして扱われます。

Example 
package main

import (
	"github.com/shogo82148/std/errors"
	"github.com/shogo82148/std/flag"
	"github.com/shogo82148/std/fmt"
	"github.com/shogo82148/std/net"
	"github.com/shogo82148/std/os"
)

func main() {
	fs := flag.NewFlagSet("ExampleFunc", flag.ContinueOnError)
	fs.SetOutput(os.Stdout)
	var ip net.IP
	fs.Func("ip", "`IP address` to parse", func(s string) error {
		ip = net.ParseIP(s)
		if ip == nil {
			return errors.New("could not parse IP")
		}
		return nil
	})
	fs.Parse([]string{"-ip", "127.0.0.1"})
	fmt.Printf("{ip: %v, loopback: %t}\n\n", ip, ip.IsLoopback())

	// 256は有効なIPv4コンポーネントではありません。
	fs.Parse([]string{"-ip", "256.0.0.1"})
	fmt.Printf("{ip: %v, loopback: %t}\n\n", ip, ip.IsLoopback())

}

Output:
{ip: 127.0.0.1, loopback: true}

invalid value "256.0.0.1" for flag -ip: could not parse IP
Usage of ExampleFunc:
  -ip IP address
    	IP address to parse
{ip: <nil>, loopback: false}

func Int 

func Int(name string, value int, usage string) *int

Intは指定した名前、デフォルト値、使用方法の文字列を持つintフラグを定義します。 返り値は、フラグの値を格納するint変数のアドレスです。

func Int64 

func Int64(name string, value int64, usage string) *int64

Int64は指定された名前、デフォルト値、使用方法の文字列を持つint64フラグを定義します。 返り値は、フラグの値を保持するint64変数のアドレスです。

func Int64Var 

func Int64Var(p *int64, name string, value int64, usage string)

Int64Varは、指定された名前、デフォルト値、使用方法の文字列を持つint64フラグを定義します。 引数pは、フラグの値を格納するためのint64変数を指すポインタです。

func IntVar 

func IntVar(p *int, name string, value int, usage string)

IntVarは指定された名前、デフォルト値、使用方法の文字列を持つintフラグを定義します。 引数pはフラグの値を格納するint変数を指すポインタです。

func NArg 

func NArg() int

NArgは、フラグが処理された後の残りの引数の数です。

func NFlag 

func NFlag() int

NFlagは設定されたコマンドラインフラグの数を返します。

func Parse 

func Parse()

Parseは os.Args[1:] からコマンドラインフラグを解析します。全てのフラグが定義された後、プログラムによってフラグにアクセスされる前に呼び出す必要があります。

func Parsed 

func Parsed() bool

Parsedは、コマンドラインフラグが解析されたかどうかを示します。

func PrintDefaults 

func PrintDefaults()

PrintDefaultsは、標準エラー出力に、設定がない場合はデフォルトの設定を表示する使用方法メッセージを出力します。 整数値のフラグxに対して、デフォルトの出力形式は次のようになります。 

-x int
	xの使用方法メッセージ（デフォルト 7）

使用方法メッセージは、boolフラグ以外の場合には別の行に表示されます。boolフラグの場合は、型は省略され、フラグ名が1バイトの場合は使用方法メッセージが同じ行に表示されます。デフォルト値が型のゼロ値である場合、カッコ内のデフォルトは省略されます。ここではintと表示されていますが、フラグの使用方法文字列にバッククォートで囲まれた名前を記述することで、リストされる型を変更することができます。メッセージ中の最初のこのような項目が、メッセージ内で表示される引数の名前として扱われ、メッセージが表示される際にはバッククォートが剥がされます。例えば、以下のようにすると、 

flag.String("I", "", "includeファイルを検索する`ディレクトリ`")

出力は次のようになります。 

-I ディレクトリ
	ディレクトリを検索するincludeファイル。

フラグメッセージの出力先を変更するには、 CommandLine.SetOutputを呼び出します。

func Set 

func Set(name, value string) error

Setは名前付きのコマンドラインフラグの値を設定します。

func String 

func String(name string, value string, usage string) *string

Stringは指定された名前、デフォルト値、使用方法のストリングフラグを定義します。 返り値は、フラグの値を保存する文字列変数のアドレスです。

func StringVar 

func StringVar(p *string, name string, value string, usage string)

StringVarは、指定された名前、デフォルト値、使用法の文字列を持つ文字列フラグを定義します。 引数pは、フラグの値を格納する文字列変数を指すポインタです。

func TextVar added in v1.19.0 

func TextVar(p encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, usage string)

TextVarは指定された名前、デフォルト値、使用方法を持つフラグを定義します。 引数pは値を保持する変数へのポインタでなければならず、pはencoding.TextUnmarshalerを実装しなければなりません。 フラグが使用される場合、フラグの値はpのUnmarshalTextメソッドに渡されます。 デフォルト値の型はpの型と同じでなければなりません。

Example 
package main

import (
	"github.com/shogo82148/std/flag"
	"github.com/shogo82148/std/fmt"
	"github.com/shogo82148/std/net"
	"github.com/shogo82148/std/os"
)

func main() {
	fs := flag.NewFlagSet("ExampleTextVar", flag.ContinueOnError)
	fs.SetOutput(os.Stdout)
	var ip net.IP
	fs.TextVar(&ip, "ip", net.IPv4(192, 168, 0, 100), "`IP address` to parse")
	fs.Parse([]string{"-ip", "127.0.0.1"})
	fmt.Printf("{ip: %v}\n\n", ip)

	// 256は有効なIPv4コンポーネントではありません
	ip = nil
	fs.Parse([]string{"-ip", "256.0.0.1"})
	fmt.Printf("{ip: %v}\n\n", ip)

}

Output:
{ip: 127.0.0.1}

invalid value "256.0.0.1" for flag -ip: invalid IP address: 256.0.0.1
Usage of ExampleTextVar:
  -ip IP address
    	IP address to parse (default 192.168.0.100)
{ip: <nil>}

func Uint 

func Uint(name string, value uint, usage string) *uint

Uintは指定された名前、デフォルト値、使用法の文字列を持つuintフラグを定義します。 返り値は、フラグの値を格納するuint変数のアドレスです。

func Uint64 

func Uint64(name string, value uint64, usage string) *uint64

Uint64は指定された名前、デフォルト値、使用法の文字列を持つuint64フラグを定義します。 返り値は、フラグの値を格納するuint64変数のアドレスです。

func Uint64Var 

func Uint64Var(p *uint64, name string, value uint64, usage string)

Uint64Varは指定された名前、デフォルト値、および使用法の文字列でuint64フラグを定義します。 引数pはフラグの値を格納するためのuint64変数を指すポインタです。

func UintVar 

func UintVar(p *uint, name string, value uint, usage string)

UintVarは指定された名前、デフォルト値、および使用法の文字列でuintフラグを定義します。 引数pは、フラグの値を格納するuint変数を指すポインタです。

func UnquoteUsage added in v1.5.0 

func UnquoteUsage(flag *Flag) (name string, usage string)

UnquoteUsageは、フラグの使用法の場所から引用符で囲まれた名前を取り出し、 それとその引用符を取り除いた使用法を返します。 "a `name` to show"と与えられた場合、("name", "a name to show")を返します。 もし引用符がない場合、その名前はフラグの値の型の教養された推測であり、もしフラグがブール値であれば空の文字列です。

func Var 

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

Varは指定された名前と使用方法のフラグを定義します。フラグの型と値は、通常は Value 型の最初の引数で表されます。この Value 型は一般的に、ユーザー定義の Value 型の実装を保持します。たとえば、呼び出し側は、値のメソッドを持つスライスにコンマ区切りの文字列を変換するフラグを作成することができます。特に、Set はコンマ区切りの文字列をスライスに分解します。

func Visit 

func Visit(fn func(*Flag))

Visitは辞書順でコマンドラインフラグを訪問し、各フラグに対してfnを呼び出します。 設定されたフラグのみを訪問します。

func VisitAll 

func VisitAll(fn func(*Flag))

VisitAllはコマンドラインフラグを辞書順に訪れ、それぞれに対してfnを呼び出します。設定されていないフラグも含めて、すべてのフラグを訪れます。

Types

type ErrorHandling 

type ErrorHandling int

ErrorHandlingは、parseが失敗した場合に FlagSet.Parse の動作を定義します。 

const (
	ContinueOnError ErrorHandling = iota
	ExitOnError
	PanicOnError
)

これらの定数は、パースが失敗した場合に FlagSet.Parse が説明された動作をするようにします。

type Flag 

type Flag struct {
	Name     string
	Usage    string
	Value    Value
	DefValue string
}

Flagはフラグの状態を表します。

func Lookup 

func Lookup(name string) *Flag

Lookupは指定されたコマンドラインフラグの Flag 構造体を返します。存在しない場合はnilを返します。

type FlagSet 

type FlagSet struct {

	// Usage はフラグの解析中にエラーが発生した場合に呼び出される関数です。
	// このフィールドは、カスタムのエラーハンドラを指すように変更できる関数（メソッドではありません）です。
	// Usage が呼び出された後に何が起こるかは、ErrorHandling の設定に依存します。
	// コマンドラインでは ExitOnError がデフォルトであり、Usage の呼び出し後にプログラムが終了します。
	Usage func()
	// contains filtered or unexported fields
}

FlagSetは定義されたフラグの集合を表します。FlagSetのゼロ値は名前を持たず、 ContinueOnError エラーハンドリングを持ちます。 Flag の名前はFlagSet内でユニークでなければなりません。既に使用されている名前でフラグを定義しようとすると、パニックが発生します。

Example 
package main

import (
	"github.com/shogo82148/std/flag"
	"github.com/shogo82148/std/fmt"
	"github.com/shogo82148/std/time"
)

func main() {

	start := func(args []string) {
		// A real program (not an example) would use flag.ExitOnError.
		fs := flag.NewFlagSet("start", flag.ContinueOnError)
		addr := fs.String("addr", ":8080", "`address` to listen on")
		if err := fs.Parse(args); err != nil {
			fmt.Printf("error: %s", err)
			return
		}
		fmt.Printf("starting server on %s\n", *addr)
	}

	stop := func(args []string) {
		fs := flag.NewFlagSet("stop", flag.ContinueOnError)
		timeout := fs.Duration("timeout", time.Second, "stop timeout duration")
		if err := fs.Parse(args); err != nil {
			fmt.Printf("error: %s", err)
			return
		}
		fmt.Printf("stopping server (timeout=%v)\n", *timeout)
	}

	main := func(args []string) {
		subArgs := args[2:] // Drop program name and command.
		switch args[1] {
		case "start":
			start(subArgs)
		case "stop":
			stop(subArgs)
		default:
			fmt.Printf("error: unknown command - %q\n", args[1])
			// In a real program (not an example) print to os.Stderr and exit the program with non-zero value.
		}
	}

	main([]string{"httpd", "start", "-addr", ":9999"})
	main([]string{"httpd", "stop"})
	main([]string{"http", "start", "-log-level", "verbose"})

}

Output:
starting server on :9999
stopping server (timeout=1s)
error: flag provided but not defined: -log-level

func NewFlagSet 

func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet

NewFlagSetは指定された名前とエラーハンドリングプロパティを持つ新しい空のフラグセットを返します。名前が空でない場合、デフォルトの使用方法メッセージとエラーメッセージに表示されます。

func (*FlagSet) Arg 

func (f *FlagSet) Arg(i int) string

Argはi番目の引数を返します。Arg(0)はフラグが処理された後の最初の残りの引数です。存在しない要素が要求された場合、Argは空の文字列を返します。

func (*FlagSet) Args 

func (f *FlagSet) Args() []string

Argsはフラグ以外の引数を返します。

func (*FlagSet) Bool 

func (f *FlagSet) Bool(name string, value bool, usage string) *bool

Boolは、指定した名前、デフォルト値、使用法の説明でboolフラグを定義します。 戻り値は、フラグの値を格納するbool変数のアドレスです。

func (*FlagSet) BoolFunc added in v1.21.0 

func (f *FlagSet) BoolFunc(name, usage string, fn func(string) error)

BoolFuncは値を必要とせず、指定された名前と使用方法の文字列でフラグを定義します。 フラグが見つかる度に、fnがフラグの値と一緒に呼び出されます。 もしfnが非nilのエラーを返した場合、それはフラグ値の解析エラーとして扱われます。

func (*FlagSet) BoolVar 

func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string)

BoolVarは指定された名前、デフォルト値、および使用法の文字列を持つboolフラグを定義します。 引数pはフラグの値を格納するためのbool変数を指すポインタです。

func (*FlagSet) Duration 

func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration

Durationは指定された名前、デフォルト値、および使用法の文字列を持つtime.Durationフラグを定義します。 戻り値は、フラグの値を格納するtime.Duration変数のアドレスです。 このフラグは、time.ParseDurationが受け入れ可能な値を受け入れます。

func (*FlagSet) DurationVar 

func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string)

DurationVarは、指定された名前、デフォルト値、使用方法を持つtime.Durationフラグを定義します。 引数pは、フラグの値を保存するためのtime.Duration変数を指すポインタです。 このフラグは、time.ParseDurationで受け入れ可能な値を受け入れます。

func (*FlagSet) ErrorHandling added in v1.10.0 

func (f *FlagSet) ErrorHandling() ErrorHandling

ErrorHandlingはフラグセットのエラーハンドリングの動作を返します。

func (*FlagSet) Float64 

func (f *FlagSet) Float64(name string, value float64, usage string) *float64

Float64は指定された名前、デフォルト値、使用方法の文字列を持つfloat64フラグを定義します。 返り値は、フラグの値を格納するfloat64変数のアドレスです。

func (*FlagSet) Float64Var 

func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string)

Float64Varは、指定した名前、デフォルト値、使用法の文字列を持つfloat64フラグを定義します。 引数pは、フラグの値を格納するfloat64変数を指すポインタです。

func (*FlagSet) Func added in v1.16.0 

func (f *FlagSet) Func(name, usage string, fn func(string) error)

Funcは指定された名前と使用方法の文字列でフラグを定義します。 フラグが見つかるたびに、fnがフラグの値で呼び出されます。 fnが非nilのエラーを返す場合、それはフラグ値の解析エラーとして扱われます。

func (*FlagSet) Init 

func (f *FlagSet) Init(name string, errorHandling ErrorHandling)

Initはフラグセットの名前とエラーハンドリングプロパティを設定します。 デフォルトでは、ゼロ値の FlagSet は空の名前と ContinueOnError のエラーハンドリングポリシーを使用します。

func (*FlagSet) Int 

func (f *FlagSet) Int(name string, value int, usage string) *int

Intは指定された名前、デフォルト値、使用法の文字列を持つintフラグを定義します。 返り値は、フラグの値を格納するint変数のアドレスです。

func (*FlagSet) Int64 

func (f *FlagSet) Int64(name string, value int64, usage string) *int64

Int64は、指定された名前、デフォルト値、および使用法の文字列を持つint64フラグを定義します。 戻り値は、フラグの値を格納するint64変数のアドレスです。

func (*FlagSet) Int64Var 

func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string)

Int64Varは指定された名前、デフォルト値、使用方法の文字列を持つint64フラグを定義します。 引数pは、フラグの値を格納するint64変数を指すポインタです。

func (*FlagSet) IntVar 

func (f *FlagSet) IntVar(p *int, name string, value int, usage string)

IntVarは指定された名前、デフォルト値、使用法の文字列を持つintフラグを定義します。 引数pはフラグの値を格納するint変数を指すポインタです。

func (*FlagSet) Lookup 

func (f *FlagSet) Lookup(name string) *Flag

Lookupは指定された Flag 構造体を返します。存在しない場合はnilを返します。

func (*FlagSet) NArg 

func (f *FlagSet) NArg() int

NArgはフラグ処理後に残る引数の数です。

func (*FlagSet) NFlag 

func (f *FlagSet) NFlag() int

NFlagは設定されているフラグの数を返します。

func (*FlagSet) Name added in v1.10.0 

func (f *FlagSet) Name() string

Nameはフラグセットの名前を返します。

func (*FlagSet) Output added in v1.10.0 

func (f *FlagSet) Output() io.Writer

Output は使用方法やエラーメッセージのための出力先を返します。 output が設定されていない場合や nil に設定されている場合は、os.Stderr が返されます。

func (*FlagSet) Parse 

func (f *FlagSet) Parse(arguments []string) error

Parseは引数リストからフラグ定義を解析します。コマンド名は含まれていてはいけません。 FlagSet 内のすべてのフラグが定義され、プログラムによってフラグにアクセスされる前に呼び出す必要があります。 返り値は、-helpまたは-hが設定されているが定義されていない場合、 ErrHelp になります。

func (*FlagSet) Parsed 

func (f *FlagSet) Parsed() bool

Parsedはf.Parseが呼ばれたかどうかを報告する。

func (*FlagSet) PrintDefaults 

func (f *FlagSet) PrintDefaults()

PrintDefaultsは、設定されていない限り、標準エラー出力に、セット内のすべての定義されたコマンドラインフラグのデフォルト値を表示します。詳細については、グローバル関数PrintDefaultsのドキュメントを参照してください。

func (*FlagSet) Set 

func (f *FlagSet) Set(name, value string) error

Setは指定したフラグの値を設定します。

func (*FlagSet) SetOutput 

func (f *FlagSet) SetOutput(output io.Writer)

SetOutputは使用法やエラーメッセージの出力先を設定します。 もしoutputがnilの場合、os.Stderr が使用されます。

func (*FlagSet) String 

func (f *FlagSet) String(name string, value string, usage string) *string

Stringは、指定された名前、デフォルト値、および使用法の文字列で文字列フラグを定義します。 返り値は、フラグの値を格納する文字列変数のアドレスです。

func (*FlagSet) StringVar 

func (f *FlagSet) StringVar(p *string, name string, value string, usage string)

StringVarは指定された名前、デフォルト値、および使用法の文字列を持つ文字列フラグを定義します。 引数pは、フラグの値を格納するための文字列変数を指すポインタです。

func (*FlagSet) TextVar added in v1.19.0 

func (f *FlagSet) TextVar(p encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, usage string)

TextVarは指定された名前、デフォルト値、使用方法のフラグを定義します。 引数pは値を保持する変数へのポインタでなければならず、pはencoding.TextUnmarshalerを実装していなければなりません。 フラグが使用された場合、フラグの値はpのUnmarshalTextメソッドに渡されます。 デフォルト値の型はpの型と同じである必要があります。

func (*FlagSet) Uint 

func (f *FlagSet) Uint(name string, value uint, usage string) *uint

Uintは指定した名前、デフォルトの値、および使用方法の文字列を持つuintフラグを定義します。 戻り値は、フラグの値を格納するuint変数のアドレスです。

func (*FlagSet) Uint64 

func (f *FlagSet) Uint64(name string, value uint64, usage string) *uint64

Uint64は指定された名前、デフォルト値、使用法のテキストでuint64のフラグを定義します。 返り値は、フラグの値を保持するuint64変数のアドレスです。

func (*FlagSet) Uint64Var 

func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string)

Uint64Varは、指定された名前、デフォルト値、使用方法の文字列を持つuint64フラグを定義します。 引数pは、フラグの値を格納するためのuint64変数を指すポインタです。

func (*FlagSet) UintVar 

func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string)

UintVarは、指定された名前、デフォルト値、および使用方法の文字列を持つuintフラグを定義します。 引数pは、フラグの値を格納するuint変数を指すポインタです。

func (*FlagSet) Var 

func (f *FlagSet) Var(value Value, name string, usage string)

Varは指定された名前と使用方法のフラグを定義します。フラグの型と値は、通常、Value という型の最初の引数で示され、Value のユーザー定義の実装を保持します。例えば、呼び出し元は、Value のメソッドを持つスライスにカンマ区切りの文字列を変換するフラグを作成することができます。特に、Set メソッドはカンマ区切りの文字列をスライスに分解します。

func (*FlagSet) Visit 

func (f *FlagSet) Visit(fn func(*Flag))

Visitは辞書順にフラグを訪れ、それぞれに対してfnを呼び出します。 設定されているフラグのみを訪れます。

func (*FlagSet) VisitAll 

func (f *FlagSet) VisitAll(fn func(*Flag))

VisitAllは辞書順にフラグを訪れ、それぞれについてfnを呼び出します。 設定されていないフラグも含めて、すべてのフラグを訪れます。

type Getter added in v1.2.0 

type Getter interface {
	Value
	Get() any
}

Getterは Value の内容を取得することを可能にするインターフェースです。 これはGo 1以降の互換性規則のために、 Value インターフェースの一部ではなく、ラップされています。 このパッケージで提供されるすべての Value 型は、 Getter インターフェースを満たしますが、 Func によって使用される型は満たしません。

type Value 

type Value interface {
	String() string
	Set(string) error
}

Valueはフラグに格納されている動的な値へのインターフェースです。 （デフォルト値は文字列で表されます。）

Valueがtrueを返すIsBoolFlag() boolメソッドを持つ場合、 コマンドラインパーサーは-nameを-name=trueと等価にし、次のコマンドライン引数を使用しないようにします。

flagが存在するごとに、Setメソッドがコマンドラインの順序で一度呼び出されます。 flagパッケージはゼロ値のレシーバ（nilポインタなど）で String メソッドを呼び出す場合があります。

Example 
fs := flag.NewFlagSet("ExampleValue", flag.ExitOnError)
fs.Var(&URLValue{u}, "url", "URL to parse")

fs.Parse([]string{"-url", "https://golang.org/pkg/flag/"})
fmt.Printf(`{scheme: %q, host: %q, path: %q}`, u.Scheme, u.Host, u.Path)

Output:
{scheme: "https", host: "golang.org", path: "/pkg/flag/"}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.