timestamp

README

Timestamp

Standard cross-language timestamp object.

Introduction

This is a simple protobuf encoding for timestamps.

Note: in most cases you will want to use the built-in Protobuf timestamp. This is just a helpful implementation for those cases where a simpler uint64 millisecond representation makes more sense.

Documentation

Index

• Variables
• func ToTime(t uint64) time.Time
• type Timestamp
  • func Now() Timestamp
  • func ToTimestamp(t time.Time) Timestamp
  • func (t *Timestamp) Clone() *Timestamp
  • func (*Timestamp) Descriptor() ([]byte, []int)
  • func (t *Timestamp) Equals(ot *Timestamp) bool
  • func (m *Timestamp) GetTimeUnixMs() uint64
  • func (*Timestamp) ProtoMessage()
  • func (m *Timestamp) Reset()
  • func (m *Timestamp) String() string
  • func (t *Timestamp) ToTime() time.Time
  • func (t *Timestamp) Validate(allowEmpty bool) error
  • func (m *Timestamp) XXX_DiscardUnknown()
  • func (m *Timestamp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Timestamp) XXX_Merge(src proto.Message)
  • func (m *Timestamp) XXX_Size() int
  • func (m *Timestamp) XXX_Unmarshal(b []byte) error

Variables

var (
	// ErrEmptyTimestamp is returned if the timestamp was empty.
	ErrEmptyTimestamp = errors.New("timestamp is empty")
)

Functions

func ToTime

func ToTime(t uint64) time.Time

ToTime generates a time object from a millisecond timestamp.

Types

type Timestamp

type Timestamp struct {
	// TimeUnixMs timestamp in unix milliseconds.
	TimeUnixMs           uint64   `protobuf:"varint,1,opt,name=time_unix_ms,json=timeUnixMs,proto3" json:"time_unix_ms,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Timestamp contains a cross-platform timestamp.

func Now

func Now() Timestamp

Now returns a timestamp for now.

func ToTimestamp

func ToTimestamp(t time.Time) Timestamp

ToTimestamp generates a millisecond timestamp from the time object.

func (*Timestamp) Clone

func (t *Timestamp) Clone() *Timestamp

Clone copies the timestamp.

func (*Timestamp) Descriptor

func (*Timestamp) Descriptor() ([]byte, []int)

func (*Timestamp) Equals

func (t *Timestamp) Equals(ot *Timestamp) bool

Equals checks if the timestamp equals another timestamp.

func (*Timestamp) GetTimeUnixMs

func (m *Timestamp) GetTimeUnixMs() uint64

func (*Timestamp) ProtoMessage

func (*Timestamp) ProtoMessage()

func (*Timestamp) Reset

func (m *Timestamp) Reset()

func (*Timestamp) String

func (m *Timestamp) String() string

func (*Timestamp) ToTime

func (t *Timestamp) ToTime() time.Time

ToTime converts the Timestamp to a time.Time

func (*Timestamp) Validate

func (t *Timestamp) Validate(allowEmpty bool) error

Validate checks the timestamp.

func (*Timestamp) XXX_DiscardUnknown

func (m *Timestamp) XXX_DiscardUnknown()

func (*Timestamp) XXX_Marshal

func (m *Timestamp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Timestamp) XXX_Merge

func (m *Timestamp) XXX_Merge(src proto.Message)

func (*Timestamp) XXX_Size

func (m *Timestamp) XXX_Size() int

func (*Timestamp) XXX_Unmarshal

func (m *Timestamp) XXX_Unmarshal(b []byte) error