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

Overview

Package timestamp is a generated protocol buffer package.

It is generated from these files:

github.com/aperturerobotics/timestamp/timestamp.proto

It has these top-level messages:

Timestamp

Index

• func ToTime(t uint64) time.Time
• type Timestamp
  • func Now() Timestamp
  • func ToTimestamp(t time.Time) Timestamp
  • func (*Timestamp) Descriptor() ([]byte, []int)
  • 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() error

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" json:"time_unix_ms,omitempty"`
}

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) Descriptor

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

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() error

Validate checks the timestamp.