Documentation
¶
Index ¶
- func Apply[T any](fn func(T), arg T)
- func ApplyMany[T any](fn func(T), args []T)
- func ApplySafe[T any](fn func(T), arg T)
- func ApplyUnless[T any](cond bool, op func(T), arg T)
- func ApplyWhen[T any](cond bool, op func(T), arg T)
- func Call(op func())
- func CallIfElse(cond bool, doIf func(), doElse func())
- func CallMany(ops []func())
- func CallSafe(op func())
- func CallTimes(n int, op func())
- func CallUnless(cond bool, op func())
- func CallWhen(cond bool, op func())
- func CallWithContext(op func(context.Context))
- func CallWithTimeout(dur time.Duration, op func(context.Context))
- func Cast[T any](in any) (v T, ok bool)
- func Check[T any](value T, err error) (zero T, _ bool)
- func Convert[A any, B any](mapper func(A) B, values iter.Seq[A]) iter.Seq[B]
- func Default[T comparable](input T, defaultValue T) T
- func DefaultFuture[T comparable](input T, fn func() T) T
- func DefaultNew[T any](input *T) *T
- func Do[T any](op func() T) T
- func DoIfElse[T any](cond bool, doIf func() T, doElse func() T) T
- func DoMany[T any](ops []func() T) iter.Seq[T]
- func DoMany2[A any, B any](ops []func() (A, B)) iter.Seq2[A, B]
- func DoSafe[T any](op func() T) (out T)
- func DoTimes[T any](n int, op func() T) iter.Seq[T]
- func DoUnless[T any](cond bool, op func() T) T
- func DoWhen[T any](cond bool, op func() T) (out T)
- func DoWithContext[T any](op func(context.Context) T) (out T)
- func Flip[A any, B any](first A, second B) (B, A)
- func IfElse[T any](cond bool, ifVal T, elseVal T) T
- func Ignore[T any](_ T)
- func IgnoreError(_ error)
- func IgnoreFirst[A any, B any](_ A, b B) B
- func IgnoreSecond[A any, B any](a A, _ B) A
- func Is(p bool) bool
- func IsNil(in any) bool
- func IsOk[T any](_ T, ok bool) bool
- func IsPtr(in any) bool
- func IsType[T any](in any) bool
- func IsZero[T comparable](in T) bool
- func Join(fns []func()) func()
- func Must[T any](arg T, err error) T
- func MustBeOk[T any](out T, ok bool) T
- func Not(p bool) bool
- func NotZero[T comparable](in T) bool
- func Ptr[T any](in T) *T
- func Recover(ob func(error))
- func Ref[T any](in *T) T
- func RefOk[T any](in *T) (value T, ok bool)
- func SafeCast[T any](in any) T
- func Slice[T any](items ...T) []T
- func WithRecoverApply[T any](op func(T), in T) (err error)
- func WithRecoverCall(fn func()) (err error)
- func WithRecoverDo[T any](fn func() T) (_ T, err error)
- func WithRecoverOk[T any](fn func() (T, error)) (zero T, ok bool)
- func Wrap[T any](in T) func() T
- func WrapRecoverCall(fn func()) func() error
- func WrapRecoverDo[T any](fn func() T) func() (T, error)
- func WrapRecoverOk[T any](fn func() (T, error)) func() (T, bool)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Apply ¶ added in v0.10.3
func Apply[T any](fn func(T), arg T)
Apply calls the input function with the provided argument.
func ApplyMany ¶ added in v0.12.0
func ApplyMany[T any](fn func(T), args []T)
ApplyMany calls the function on each of the items in the provided slice. ApplyMany is a noop if the function is nil.
func ApplySafe ¶ added in v0.12.0
func ApplySafe[T any](fn func(T), arg T)
ApplySafe calls the function, fn, on the value, arg, only if the function is not nil.
func ApplyUnless ¶ added in v0.12.0
ApplyUnless runs the function with the supplied argument only when the condition is true. Panics if the function is nil.
func ApplyWhen ¶ added in v0.12.0
ApplyWhen runs the function with the supplied argument only when the condition is true. Panics if the function is nil.
func CallIfElse ¶ added in v0.12.0
func CallIfElse(cond bool, doIf func(), doElse func())
CallIfElse is, effectively the if-form from (many) lisps: when the condition is true, the first function is called, and otherwise the second. If the appropriate function is nil, CallIfElse is a noop. The "other" function call is never called.
func CallMany ¶ added in v0.12.0
func CallMany(ops []func())
CallMany calls each of the provided function, skipping any nil functions.
func CallSafe ¶ added in v0.12.0
func CallSafe(op func())
CallSafe only calls the operation when it's non-nil.
func CallTimes ¶ added in v0.12.0
func CallTimes(n int, op func())
CallTimes runs the specified option n times.
func CallUnless ¶ added in v0.12.0
func CallUnless(cond bool, op func())
CallUnless is inverse form of CallWhen, calling the provided function only when the conditional is false. Panics if the function is nil.
func CallWhen ¶ added in v0.12.0
func CallWhen(cond bool, op func())
CallWhen runs a function when condition is true, and is a noop otherwise. Panics if the function is nil.
func CallWithContext ¶ added in v0.12.0
CallWithContext runs the function, which is the same type as a fun.Operation, with a new context that is canceled after the function exits.
func CallWithTimeout ¶ added in v0.12.0
CallWithTimeout runs the function, which is the same type as fun.Operation, with a new context that expires after the specified duration.
func Check ¶ added in v0.12.0
Check can wrap a the callsite of a function that returns a value and an error, and returns (zero, false) if the error is non, nil, and (value, true) if the error is nil.
func Convert ¶ added in v0.12.0
Convert takes a sequence of A and converts it, lazily into a sequence of B, using the mapper function.
func Default ¶
func Default[T comparable](input T, defaultValue T) T
Default takes two values. if the first value is the zero value for the type T, then Default returns the second (default) value. Otherwise it returns the first input type.
func DefaultFuture ¶ added in v0.10.5
func DefaultFuture[T comparable](input T, fn func() T) T
DefaultFuture combines Default() and WhenDo: if the input value is NOT the zero value for the comparable type T it is returned directly; otherwise DefaultFuture calls the provided function and returns its output.
func DefaultNew ¶ added in v0.10.4
func DefaultNew[T any](input *T) *T
DefaultNew checks a pointer to a value, and when it is nil, constructs a new value of the same type.
func Do ¶ added in v0.12.0
func Do[T any](op func() T) T
Do executes the provided function and returns its result.
func DoIfElse ¶ added in v0.12.0
DoIfElse returns the output of the first function when the condition is false, and the value of the second function otherwise. If the appropriate function is nil, DoIfElse returns the zero value for the type. The "other" function call is never called.
func DoMany ¶ added in v0.12.0
DoMany calls each of the provided functions and returns an iterator of their results.
func DoMany2 ¶ added in v0.12.0
DoMany2 calls each of the provided functions and returns an iterator of their results.
func DoSafe ¶ added in v0.12.0
func DoSafe[T any](op func() T) (out T)
DoSafe calls the function when the operation is non-nil, and returns either the output of the function or the zero value of T.
func DoTimes ¶
DoMany calls the provided functions n times and returns an iterator of their results.
func DoUnless ¶ added in v0.12.0
DoUnless is the inverse form of DoWhen, calling the function only when the condition is false. Panics if the function is nil.
func DoWhen ¶ added in v0.12.0
DoWhen calls the function when the condition is true, and returns the result, or if the condition is false, the operation is a noop, and returns zero-value for the type. Panics if the function is nil.
func DoWithContext ¶ added in v0.12.0
func Flip ¶
Flip takes two arguments and returns them in the opposite order. Intended to wrap other functions to reduce the friction when briding APIs.
func IfElse ¶ added in v0.12.0
IfElse provides a ternary-like operation as a complement to IfDo and IfCall for values.
func Ignore ¶ added in v0.10.3
func Ignore[T any](_ T)
Ignore is a noop, but can be used to annotate operations rather than assigning to the empty identifier:
_ = operation() ft.Ignore(operation())
func IgnoreFirst ¶
IgnoreFirst takes two arguments and returns only the second, for use in wrapping functions that return two values.
func IgnoreSecond ¶
IgnoreSecond takes two arguments and returns only the first, for use when wrapping functions that return two values.
func IsOk ¶ added in v0.10.9
IsOk returns only the second argument passed to it, given a function that returns two values where the second value is a boolean, you can use IsOk to discard the first value.
func IsZero ¶
func IsZero[T comparable](in T) bool
IsZero returns true if the input value compares "true" to the zero value for the type of the argument. If the type implements an IsZero() method (e.g. time.Time), then IsZero returns that value, otherwise, IsZero constructs a zero valued object of type T and compares the input value to the zero value.
func Join ¶ added in v0.10.8
func Join(fns []func()) func()
Join creates a function that iterates over all of the input functions and calls all non-nil functions sequentially. Nil functions are ignored.
func Must ¶
Must wraps a function that returns a value and an error, and converts the error to a panic.
func MustBeOk ¶
MustBeOk raises an invariant violation if the ok value is false, and returns the first value if the second value is ok. Useful as in:
out := ft.MustBeOk(func() (string, bool) { return "hello world", true })
func NotZero ¶
func NotZero[T comparable](in T) bool
NotZero returns true when the item does not have the zero value for the type T.
func Ptr ¶
func Ptr[T any](in T) *T
Ptr returns a pointer for the object. Useful for setting the value in structs where you cannot easily create a reference (e.g. the output of functions, and for constant literals.). If you pass a value that is a pointer (e.x. *string), then Ptr returns **string. If the input object is a nil pointer, then Ptr returns a non-nil pointer to a nil pointer.
func Recover ¶ added in v0.12.0
func Recover(ob func(error))
Recover catches a panic, turns it into an error and passes it to the provided observer function.
func Ref ¶
func Ref[T any](in *T) T
Ref takes a pointer to an value and dereferences it, If the input value is nil, the output value is the zero value of the type.
func RefOk ¶ added in v0.10.9
RefOk takes a pointer to an value and returns the concrete type for that pointer. If the pointer is nil, RefOk returns the zero value for that type. The boolean value indicates if the zero value returned is because the reference.
func SafeCast ¶
SafeCast casts the input object to the specified type, and returns either, the result of the cast, or a zero value for the specified type.
func Slice ¶ added in v0.12.0
func Slice[T any](items ...T) []T
Slice returns a slice for the variadic arguments. Useful for adapting functions that take slice arguments where it's easier to pass values variadicly.
func WithRecoverApply ¶ added in v0.12.0
WithRecoverApply runs a function with a panic handler that converts the panic to an error.
func WithRecoverCall ¶ added in v0.12.0
func WithRecoverCall(fn func()) (err error)
WithRecoverCall runs a function without arguments that does not produce an error and, if the function panics, converts it into an error.
func WithRecoverDo ¶ added in v0.12.0
WithRecoverDo runs a function with a panic handler that converts the panic to an error.
func WithRecoverOk ¶ added in v0.12.0
WithRecoverOk runs a function and returns true if there are no errors and no panics the bool output value is true, otherwise it is false.
func Wrap ¶ added in v0.12.0
func Wrap[T any](in T) func() T
Wrap produces a function that always returns the value provided. Useful for bridging interface paradigms, and for storing interface-typed objects in atomics.
func WrapRecoverCall ¶ added in v0.12.0
func WrapRecoverCall(fn func()) func() error
WrapRecoverCall wraps a function without arguments that does not produce an error with one that does produce an error. When called, the new function will never panic but returns an error if the input function panics.
func WrapRecoverDo ¶ added in v0.12.0
WrapRecoverDo wraps a function that returns a single value, with one that returns that argument and an error if the underlying function panics.
func WrapRecoverOk ¶ added in v0.12.0
WrapRecoverOk takes a function that returns an error and a value, and returns a wrapped function that also catches any panics in the input function, and returns the value and a boolean that is true if the input function does not return an error or panic.
Types ¶
This section is empty.
Source Files