aboutsummaryrefslogtreecommitdiff
path: root/func.go
diff options
context:
space:
mode:
authorTomas Aschan <[email protected]>2025-08-29 21:59:56 +0200
committerGitHub <[email protected]>2025-08-29 21:59:56 +0200
commitfd649b20e66a30631ee35bba78164180d02730d4 (patch)
tree321b27604470eed0b00615ea41f0f32f9bf8104a /func.go
parentd66f0ce2a7f887f0ff5f5af48649f3a01b3f0566 (diff)
parent1db553c27f5b9952dbb6484ed9999547b9e7dfb2 (diff)
Merge branch 'master' into fix-errhelp
Diffstat (limited to 'func.go')
-rw-r--r--func.go37
1 files changed, 37 insertions, 0 deletions
diff --git a/func.go b/func.go
new file mode 100644
index 0000000..9f4d88f
--- /dev/null
+++ b/func.go
@@ -0,0 +1,37 @@
+package pflag
+
+// -- func Value
+type funcValue func(string) error
+
+func (f funcValue) Set(s string) error { return f(s) }
+
+func (f funcValue) Type() string { return "func" }
+
+func (f funcValue) String() string { return "" } // same behavior as stdlib 'flag' package
+
+// Func defines a func flag with specified name, callback function and usage string.
+//
+// The callback function will be called every time "--{name}={value}" (or equivalent) is
+// parsed on the command line, with "{value}" as an argument.
+func (f *FlagSet) Func(name string, usage string, fn func(string) error) {
+ f.FuncP(name, "", usage, fn)
+}
+
+// FuncP is like Func, but accepts a shorthand letter that can be used after a single dash.
+func (f *FlagSet) FuncP(name string, shorthand string, usage string, fn func(string) error) {
+ var val Value = funcValue(fn)
+ f.VarP(val, name, shorthand, usage)
+}
+
+// Func defines a func flag with specified name, callback function and usage string.
+//
+// The callback function will be called every time "--{name}={value}" (or equivalent) is
+// parsed on the command line, with "{value}" as an argument.
+func Func(name string, usage string, fn func(string) error) {
+ CommandLine.FuncP(name, "", usage, fn)
+}
+
+// FuncP is like Func, but accepts a shorthand letter that can be used after a single dash.
+func FuncP(name, shorthand string, usage string, fn func(string) error) {
+ CommandLine.FuncP(name, shorthand, usage, fn)
+}