times

Documentation

Overview

Package times 时间相关.

Index

• Variables
• func Between(ctx context.Context, start, stop int, yield func(context.Context))
• func Format(input time.Time) string
• func FormatDate(input time.Time) string
• func FormatTime(input time.Time) string
• func Hour(yield func()) func() bool
• func InScope(start, stop int) bool
• func Parse(str string) (time.Time, error)
• func ParseNumber[T constraints.Integer | constraints.Float](num T) time.Time
• func Sleep(stop int) time.Duration
• func WithContextTimer(ctx context.Context, duration time.Duration, yield func())
• func WithTimer(duration time.Duration, yield func()) func()
• type Duration
  • func (d Duration) Short() string
  • func (d Duration) String() string
• type IDWorker
  • func NewIDWorker() *IDWorker
  • func NewIDWorkerByKey(key string) *IDWorker
  • func NewIDWorkerByMachine(machine, machineLength int64) *IDWorker
  • func (p *IDWorker) ID() int64
  • func (p *IDWorker) IDAndError() (int64, error)
  • func (p *IDWorker) IDs(num int) []int64
  • func (p *IDWorker) IDsAndError(num int) ([]int64, error)
  • func (p *IDWorker) String() string
• type IntDay
  • func Now2IntDay() IntDay
  • func ParseIntDay(str string) (IntDay, error)
  • func Time2IntDay(input time.Time) IntDay
  • func (p IntDay) Day() int
  • func (p IntDay) Marshal() []byte
  • func (p IntDay) MarshalJSON() ([]byte, error)
  • func (p IntDay) Month() int
  • func (p IntDay) String() string
  • func (p *IntDay) Unmarshal(data []byte) error
  • func (p *IntDay) UnmarshalJSON(data []byte) error
  • func (p IntDay) Year() int

Examples

• Duration.Short
• Duration.String
• Format
• FormatDate
• FormatTime
• Hour
• IDWorker.IDs
• NewIDWorker
• NewIDWorkerByKey
• NewIDWorkerByMachine
• Now2IntDay
• ParseIntDay

Variables

var (
	ErrLast       = errors.New("last id after now")
	ErrParseError = errors.New("parse error")
)

Functions

func Between

func Between(ctx context.Context, start, stop int, yield func(context.Context))

Between 时间范围内执行，超出时间终止.

func Format

func Format(input time.Time) string

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

// nolint: gochecknoglobals
var _time, _ = times.Parse("2023-08-02 12:11:30")

func main() {
	fmt.Println(times.Format(_time))

}

Output:

2023-08-02 12:11:30

func FormatDate

func FormatDate(input time.Time) string

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

// nolint: gochecknoglobals
var _time, _ = times.Parse("2023-08-02 12:11:30")

func main() {
	fmt.Println(times.FormatDate(_time))

}

Output:

2023-08-02

func FormatTime

func FormatTime(input time.Time) string

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

// nolint: gochecknoglobals
var _time, _ = times.Parse("2023-08-02 12:11:30")

func main() {
	fmt.Println(times.FormatTime(_time))

}

Output:

12:11:30

func Hour

func Hour(yield func()) func() bool

Hour 整点运行，返回取消方法.

Example

package main

import (
	"time"

	"github.com/xuender/kit/logs"
	"github.com/xuender/kit/times"
)

func main() {
	logs.I.Println("start")

	cancel := times.Hour(func() {
		logs.I.Println("run")
	})

	go func() {
		time.Sleep(time.Second)
		cancel()
		logs.I.Println("stop")
	}()

	logs.I.Println("sleep")
	time.Sleep(2 * time.Second)
	logs.I.Println("end")

}

func InScope

func InScope(start, stop int) bool

InScope 返回是否在时间范围内. nolint: cyclop

func Parse

func Parse(str string) (time.Time, error)

func ParseNumber

func ParseNumber[T constraints.Integer | constraints.Float](num T) time.Time

func Sleep

func Sleep(stop int) time.Duration

Sleep 计算睡眠时间.

func WithContextTimer

func WithContextTimer(ctx context.Context, duration time.Duration, yield func())

func WithTimer

func WithTimer(duration time.Duration, yield func()) func()

Types

type Duration

type Duration int64

func (Duration) Short

func (d Duration) Short() string

Example

package main

import (
	"fmt"
	"time"

	"github.com/xuender/kit/times"
)

func main() {
	fmt.Println(times.Duration(time.Hour * 30).Short())
	fmt.Println(times.Duration(time.Hour * 3).Short())
	fmt.Println(times.Duration(time.Minute * 3).Short())
	fmt.Println(times.Duration(time.Millisecond * 3).Short())
	fmt.Println(times.Duration(time.Second * 3).Short())
	fmt.Println(times.Duration(time.Second*3 + time.Hour*3 + 3).Short())

}

Output:

1天6小时
3小时
3分钟
3毫秒
3秒钟
3小时3秒钟

func (Duration) String

func (d Duration) String() string

Example

package main

import (
	"fmt"
	"time"

	"github.com/xuender/kit/times"
)

func main() {
	fmt.Println(times.Duration(time.Microsecond * 3))
	fmt.Println(times.Duration(time.Hour*48 + 1))

}

Output:

3微秒
2天1纳秒

type IDWorker

type IDWorker struct {
	// contains filtered or unexported fields
}

func NewIDWorker

func NewIDWorker() *IDWorker

NewIDWorker 创建非分布式的 IDWorker.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	worker := times.NewIDWorker()
	size := 10000
	ids := make(map[int64]int, size)

	for i := 0; i < size; i++ {
		ids[worker.ID()] = i
	}

	fmt.Println(len(ids))

}

Output:

10000

func NewIDWorkerByKey

func NewIDWorkerByKey(key string) *IDWorker

NewIDWorkerByKey 根据字符串创建 IDWorker.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	worker1 := times.NewIDWorkerByKey("a")
	worker2 := times.NewIDWorkerByKey("b")

	fmt.Println(worker1.ID() != worker2.ID())

}

Output:

true

func NewIDWorkerByMachine

func NewIDWorkerByMachine(machine, machineLength int64) *IDWorker

NewIDWorkerByMachine 根据机器信息创建 IDWorker.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	worker := times.NewIDWorkerByMachine(1, 19)
	size := 10000
	ids := make(map[int64]int, size)

	for i := 0; i < size; i++ {
		ids[worker.ID()] = i
	}

	fmt.Println(len(ids))

}

Output:

10000

func (*IDWorker) ID

func (p *IDWorker) ID() int64

ID 生成ID.

func (*IDWorker) IDAndError

func (p *IDWorker) IDAndError() (int64, error)

IDAndError 生成ID和错误信息.

func (*IDWorker) IDs

func (p *IDWorker) IDs(num int) []int64

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	worker := times.NewIDWorker()
	size := 10000
	ids := make(map[int64]int, size)

	for i, uid := range worker.IDs(size) {
		ids[uid] = i
	}

	fmt.Println(len(ids))

}

Output:

10000

func (*IDWorker) IDsAndError

func (p *IDWorker) IDsAndError(num int) ([]int64, error)

func (*IDWorker) String

func (p *IDWorker) String() string

String 字符串ID.

type IntDay

type IntDay int32

func Now2IntDay

func Now2IntDay() IntDay

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	day := times.Now2IntDay()
	fmt.Println(day > 0)

}

Output:

true

func ParseIntDay

func ParseIntDay(str string) (IntDay, error)

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/times"
)

func main() {
	day, err := times.ParseIntDay("20230918")

	fmt.Println(err)
	fmt.Println(day)
	fmt.Println(day.Year())
	fmt.Println(day.Month())
	fmt.Println(day.Day())

}

Output:

<nil>
20230918
2023
9
18

func Time2IntDay

func Time2IntDay(input time.Time) IntDay

func (IntDay) Day

func (p IntDay) Day() int

func (IntDay) Marshal

func (p IntDay) Marshal() []byte

func (IntDay) MarshalJSON

func (p IntDay) MarshalJSON() ([]byte, error)

func (IntDay) Month

func (p IntDay) Month() int

func (IntDay) String

func (p IntDay) String() string

func (*IntDay) Unmarshal

func (p *IntDay) Unmarshal(data []byte) error

func (*IntDay) UnmarshalJSON

func (p *IntDay) UnmarshalJSON(data []byte) error

func (IntDay) Year

func (p IntDay) Year() int