timeutil

README

timeutil

Installation

go get github.com/m0t0k1ch1-go/timeutil/v3

Documentation

Index

• type Clock
  • func NewClock() Clock
• type MockClock
  • func NewMockClock(ts Timestamp) *MockClock
  • func (clk *MockClock) Now() Timestamp
  • func (clk *MockClock) Set(ts Timestamp)
• type Timestamp
  • func Now() Timestamp
  • func TimeToTimestamp(t time.Time) Timestamp
  • func (ts Timestamp) MarshalJSON() ([]byte, error)
  • func (ts *Timestamp) Scan(src any) error
  • func (ts Timestamp) String() string
  • func (ts Timestamp) Time() time.Time
  • func (ts *Timestamp) UnmarshalJSON(b []byte) error
  • func (ts Timestamp) Value() (driver.Value, error)

Types

type Clock

type Clock interface {
	Now() Timestamp
}

Clock is an interface for getting the current Timestamp.

func NewClock

func NewClock() Clock

NewClock returns a new Clock.

type MockClock

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

MockClock is a mock implementation of Clock.

func NewMockClock

func NewMockClock(ts Timestamp) *MockClock

NewMockClock returns a new MockClock.

func (*MockClock) Now

func (clk *MockClock) Now() Timestamp

Now returns the mock Timestamp.

func (*MockClock) Set

func (clk *MockClock) Set(ts Timestamp)

Set sets the mock Timestamp.

type Timestamp

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

Timestamp is a wrapper for time.Time.

func Now

func Now() Timestamp

Now returns the current Timestamp.

func TimeToTimestamp

func TimeToTimestamp(t time.Time) Timestamp

TimeToTimestamp return the Timestamp that wraps the given time.Time.

func (Timestamp) MarshalJSON

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

MarshalJSON implements the json.Marshaler interface.

func (*Timestamp) Scan

func (ts *Timestamp) Scan(src any) error

Scan implements the sql.Scanner interface.

func (Timestamp) String

func (ts Timestamp) String() string

String implements the fmt.Stringer interface.

func (Timestamp) Time

func (ts Timestamp) Time() time.Time

Time returns the wrapped time.Time.

func (*Timestamp) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaler interface.

func (Timestamp) Value

func (ts Timestamp) Value() (driver.Value, error)

Value implements the driver.Valuer interface.