Goメモ-455 (flagパッケージ再入門)(02-Var)

関連記事

Goメモ-454 (flagパッケージ再入門)(01-FlagSet) - いろいろ備忘録日記

GitHub - devlights/blog-summary: ブログ「いろいろ備忘録日記」のまとめ

概要

以下、自分用のメモです。忘れないうちにメモメモ。。。

最近、flaggy とかを利用していて、あまりflagパッケージを触らなくなってきているのですが

小さなツールをちゃちゃっとワンタイムで利用するときは、やっぱり使ったりします。

使っていないと忘れてしまいそうなので、ここに自分の備忘録として残しておこうと思います。

今回は、flag.Varについて。

flag.Var() には、任意の値をフラグハンドリングのための値として指定出来ます。

条件として、flag.Valueインターフェースを実装している必要があります。

flag.Valueインターフェースは以下のようになっています。

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

サンプル

package flags

import (
    "flag"
    "strings"

    "github.com/devlights/gomy/output"
)

type (
    // flag.Var() で指定するホスト名リスト。カンマ区切り。
    hosts []string
    // flag.Var() で指定するパスリスト。コロン区切り。
    paths []string
)

func (h hosts) String() string {
    output.Stderrl("[CALL]", "flag.Value.String()")

    return strings.Join(h, ",")
}

func (h *hosts) Set(v string) error {
    output.Stderrl("[CALL]", "flag.Value.Set()")

    *h = strings.Split(v, ",")
    return nil
}

func (p paths) String() string {
    return strings.Join(p, ":")
}

func (p *paths) Set(v string) error {
    *p = strings.Split(v, ":")
    return nil
}

// Var は、flag.Var() のサンプルです。
//
// flag.Var() には、任意の値をフラグハンドリングのための値として指定出来ます。
// 条件として、flag.Valueインターフェースを実装している必要があります。
//
// # REFERENCES
//   - https://pkg.go.dev/flag@go1.22.4#Var
//   - https://pkg.go.dev/flag@go1.22.4#Value
//   - https://serverfault.com/a/846523
//   - https://www.rfc-editor.org/rfc/rfc6761
func Var() error {
    var (
        hs    hosts
        ps    paths
        fs    = flag.NewFlagSet("", flag.ExitOnError)
        logfn = func(message string, fn func()) {
            output.Stderrl("[CALL]", message)
            fn()
        }
    )

    logfn("fs.Var", func() { fs.Var(&hs, "hosts", "host names. comma separated.") })
    fs.Var(&ps, "paths", "path list. coron separated.")

    logfn("fs.Parse", func() {
        fs.Parse([]string{"-hosts", "example.invalid,dummy.local,my.test", "-paths", "/path/to/a:/bin:/usr/bin"})
    })

    for _, h := range hs {
        output.Stdoutl("[h]", h)
    }

    for _, p := range ps {
        output.Stdoutl("[p]", p)
    }

    return nil

    /*
       $ task
       task: [build] go build .
       task: [run] ./try-golang -onetime

       ENTER EXAMPLE NAME: flags_var

       [Name] "flags_var"
       [CALL]               fs.Var
       [CALL]               flag.Value.String()
       [CALL]               fs.Parse
       [CALL]               flag.Value.Set()
       [h]                  example.invalid
       [h]                  dummy.local
       [h]                  my.test
       [p]                  /path/to/a
       [p]                  /bin
       [p]                  /usr/bin


       [Elapsed] 86µs
   */

}

参考情報

Goメモ-428 (flaggyメモ)(01) - いろいろ備忘録日記

Goメモ-429 (flaggyメモ)(02) - いろいろ備忘録日記

Goメモ-430 (flaggyメモ)(03) - いろいろ備忘録日記

Goのおすすめ書籍

初めてのGo言語 ―他言語プログラマーのためのイディオマティックGo実践ガイド

実用 Go言語 ―システム開発の現場で知っておきたいアドバイス

Go言語による並行処理

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ

Goならわかるシステムプログラミング 第2版

効率的なGo ―データ指向によるGoアプリケーションの性能最適化

---

過去の記事については、以下のページからご参照下さい。

• ブログ 「いろいろ備忘録日記」の記事まとめ | ブログ「いろいろ備忘録日記」のまとめ

サンプルコードは、以下の場所で公開しています。

• GitHub - devlights/try-golang: This is my TUTORIAL project for golang.
• GitHub - devlights/try-python: This is my TUTORIAL project for Python.
• GitHub - devlights/try-csharp: This is my TUTORIAL project for C#.