# Function
Package function can control the flow of function execution and support part of functional programming.
# Source:
- https://github.com/duke-git/lancet/blob/main/function/function.go (opens new window)
- https://github.com/duke-git/lancet/blob/main/function/watcher.go (opens new window)
# Usage:
import (
"github.com/duke-git/lancet/v2/function"
)
# Documentation
# After
Creates a function that invokes given func once it's called n or more times.
Signature:
func After(n int, fn any) func(args ...any) []reflect.Value
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
arr := []string{"a", "b"}
f := function.After(len(arr), func(i int) int {
fmt.Println("last print")
return i
})
type cb func(args ...any) []reflect.Value
print := func(i int, s string, fn cb) {
fmt.Printf("arr[%d] is %s \n", i, s)
fn(i)
}
fmt.Println("arr is", arr)
for i := 0; i < len(arr); i++ {
print(i, arr[i], f)
}
//output:
// arr is [a b]
// arr[0] is a
// arr[1] is b
// last print
}
# Before
creates a function that invokes func once it's called less than n times.
Signature:
func Before(n int, fn any) func(args ...any) []reflect.Value
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
"github.com/duke-git/lancet/v2/internal"
)
func main() {
arr := []string{"a", "b", "c", "d", "e"}
f := function.Before(3, func(i int) int {
return i
})
var res []int64
type cb func(args ...any) []reflect.Value
appendStr := func(i int, s string, fn cb) {
v := fn(i)
res = append(res, v[0].Int())
}
for i := 0; i < len(arr); i++ {
appendStr(i, arr[i], f)
}
expected := []int64{0, 1, 2, 2, 2}
fmt.Println(res) // 0, 1, 2, 2, 2
}
# Curry
Make a curry function.
Signature:
type Fn func(...any) any
func (f Fn) Curry(i any) func(...any) any
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
add := func(a, b int) int {
return a + b
}
var addCurry function.Fn = func(values ...any) any {
return add(values[0].(int), values[1].(int))
}
add1 := addCurry.Curry(1)
result := add1(2)
fmt.Println(result) //3
}
# Compose
Compose the function list from right to left, then return the composed function.
Signature:
func Compose(fnList ...func(...any) any) func(...any) any
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
add1 := func(v ...any) any {
return v[0].(int) + 1
}
add2 := func(v ...any) any {
return v[0].(int) + 2
}
add3 := function.Compose(add1, add2)
result := add3(1)
fmt.Println(result) //4
}
# Debounced
Creates a debounced function that delays invoking fn until after wait duration have elapsed since the last time the debounced function was invoked.
Signature:
func Debounced(fn func(), duration time.Duration) func()
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
count := 0
add := func() {
count++
}
debouncedAdd := function.Debounced(add, 50*time.Microsecond)
function.debouncedAdd()
function.debouncedAdd()
function.debouncedAdd()
function.debouncedAdd()
time.Sleep(100 * time.Millisecond)
fmt.Println(count) //1
function.debouncedAdd()
time.Sleep(100 * time.Millisecond)
fmt.Println(count) //2
}
# Delay
Invoke function after delayed time.
Signature:
func Delay(delay time.Duration, fn any, args ...any)
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
var print = func(s string) {
fmt.Println(count) //test delay
}
function.Delay(2*time.Second, print, "test delay")
}
# Schedule
Invoke function every duration time, until close the returned bool chan.
Signature:
func Schedule(d time.Duration, fn any, args ...any) chan bool
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
var res []string
appendStr := func(s string) {
res = append(res, s)
}
stop := function.Schedule(1*time.Second, appendStr, "*")
time.Sleep(5 * time.Second)
close(stop)
fmt.Println(res) //[* * * * *]
}
# Watcher
Watcher is used for record code excution time. can start/stop/reset the watch timer. get the elapsed time of function execution.
Signature:
type Watcher struct {
startTime int64
stopTime int64
excuting bool
}
func (w *Watcher) Start() //start the watcher
func (w *Watcher) Stop() //stop the watcher
func (w *Watcher) Reset() //reset the watcher
func (w *Watcher) GetElapsedTime() time.Duration //get the elapsed time of function execution
Example:
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/function"
)
func main() {
w := &function.Watcher{}
w.Start()
longRunningTask()
fmt.Println(w.excuting) //true
w.Stop()
eapsedTime := w.GetElapsedTime().Milliseconds()
fmt.Println(eapsedTime)
w.Reset()
fmt.Println(w.excuting) //false
fmt.Println(w.startTime) //0
fmt.Println(w.stopTime) //0
}
func longRunningTask() {
var slice []int64
for i := 0; i < 10000000; i++ {
slice = append(slice, int64(i))
}
}