timex

README

timex

Better time package for Go.

Rationale

TODO

Features

• Simple.

See GUIDE.md for more details.

Install

Go version 1.17+

go get github.com/cristalhq/timex

Example

TODO

Documentation

See these docs.

License

MIT License.

Documentation

Index

• Variables
• func MulDur(d time.Duration, scale float64) time.Duration
• func Now() time.Time
• func StopTimer(t time.Timer)
• type Clock
• type Duration
• type ManualClock
  • func NewManualClock(curr time.Time) *ManualClock
  • func (c *ManualClock) Add(d time.Duration)
  • func (c *ManualClock) Now() time.Time
  • func (c *ManualClock) Set(t time.Time)
• type Timestamp
  • func AsTimestamp(t time.Time) Timestamp
  • func (ts Timestamp) MarshalJSON() ([]byte, error)
  • func (ts *Timestamp) UnmarshalJSON(b []byte) error

Examples

• MulDur

Variables

var RealClock = &systemClock{}

var RealUTCClock = &systemUTCClock{}

Functions

func MulDur

func MulDur(d time.Duration, scale float64) time.Duration

MulDur multiplies duration by a float value.

Example

package main

import (
	"time"

	"github.com/cristalhq/timex"
)

func main() {
	window := time.Minute

	window = timex.MulDur(window, 1.5)
	if window.Seconds() != 90 {
		panic("want 90 have " + window.String())
	}

	window = time.Minute
	window = time.Duration(float64(window) * 1.5)
	if window.Seconds() != 90 {
		panic("want 90 have " + window.String())
	}

}

func Now

func Now() time.Time

Now returns currect time in UTC.

func StopTimer

func StopTimer(t time.Timer)

StopTimer in a proper manner.

Types

type Clock

type Clock interface {
	Now() time.Time
}

Clock represents interface on time. Useful in tests.

type Duration

type Duration = time.Duration

Duration is an alias for time.Duration.

type ManualClock

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

ManualClock represents clock than can be controlled manually.

func NewManualClock

func NewManualClock(curr time.Time) *ManualClock

NewManualClock returns manual Clock with a given time.

func (*ManualClock) Add

func (c *ManualClock) Add(d time.Duration)

func (*ManualClock) Now

func (c *ManualClock) Now() time.Time

func (*ManualClock) Set

func (c *ManualClock) Set(t time.Time)

type Timestamp

type Timestamp struct {
	time.Time
}

func AsTimestamp

func AsTimestamp(t time.Time) Timestamp

AsTimestamp returns time.Time wrapped as Timestamp.

func (Timestamp) MarshalJSON

func (ts Timestamp) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*Timestamp) UnmarshalJSON

func (ts *Timestamp) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler interface.