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
• func ToUnixMs(t time.Time) uint64
• type Timestamp
  • func Now() *Timestamp
  • func ToTimestamp(t time.Time) *Timestamp
  • func (t *Timestamp) Clone() *Timestamp
  • func (m *Timestamp) CloneMessageVT() proto.Message
  • func (m *Timestamp) CloneVT() *Timestamp
  • func (*Timestamp) Descriptor() ([]byte, []int)
  • func (this *Timestamp) EqualMessageVT(thatMsg proto.Message) bool
  • func (this *Timestamp) EqualVT(that *Timestamp) bool
  • func (t *Timestamp) Equals(ot *Timestamp) bool
  • func (t *Timestamp) Format(formatStr string) string
  • func (t *Timestamp) GetEmpty() bool
  • func (x *Timestamp) GetTimeUnixMs() uint64
  • func (t *Timestamp) MarshalJSON() ([]byte, error)
  • func (m *Timestamp) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Timestamp) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Timestamp) MarshalVT() (dAtA []byte, err error)
  • func (*Timestamp) ProtoMessage()
  • func (x *Timestamp) ProtoReflect() protoreflect.Message
  • func (x *Timestamp) Reset()
  • func (m *Timestamp) SizeVT() (n int)
  • func (x *Timestamp) String() string
  • func (t *Timestamp) ToRFC3339() string
  • func (t *Timestamp) ToTime() time.Time
  • func (t *Timestamp) UnmarshalJSON(data []byte) error
  • func (m *Timestamp) UnmarshalVT(dAtA []byte) error
  • func (t *Timestamp) Validate(allowEmpty bool) error

Variables

var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)

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

var File_github_com_aperturerobotics_timestamp_timestamp_proto protoreflect.FileDescriptor

Functions

func ToTime

func ToTime(t uint64) time.Time

ToTime generates a time object from a millisecond timestamp.

func ToUnixMs

func ToUnixMs(t time.Time) uint64

ToUnixMs converts a time to unix ms.

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"`
	// contains filtered or unexported fields
}

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

func (m *Timestamp) CloneMessageVT() proto.Message

func (*Timestamp) CloneVT

func (m *Timestamp) CloneVT() *Timestamp

func (*Timestamp) Descriptor

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

Deprecated: Use Timestamp.ProtoReflect.Descriptor instead.

func (*Timestamp) EqualMessageVT

func (this *Timestamp) EqualMessageVT(thatMsg proto.Message) bool

func (*Timestamp) EqualVT

func (this *Timestamp) EqualVT(that *Timestamp) bool

func (*Timestamp) Equals

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

Equals checks if the timestamp equals another timestamp.

func (*Timestamp) Format

func (t *Timestamp) Format(formatStr string) string

Format formats using time.Format.

func (*Timestamp) GetEmpty

func (t *Timestamp) GetEmpty() bool

GetEmpty checks if the timestamp is empty.

func (*Timestamp) GetTimeUnixMs

func (x *Timestamp) GetTimeUnixMs() uint64

func (*Timestamp) MarshalJSON

func (t *Timestamp) MarshalJSON() ([]byte, error)

MarshalJSON marshals to a JSON RFC3339 timestamp.

func (*Timestamp) MarshalToSizedBufferVT

func (m *Timestamp) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Timestamp) MarshalToVT

func (m *Timestamp) MarshalToVT(dAtA []byte) (int, error)

func (*Timestamp) MarshalVT

func (m *Timestamp) MarshalVT() (dAtA []byte, err error)

func (*Timestamp) ProtoMessage

func (*Timestamp) ProtoMessage()

func (*Timestamp) ProtoReflect

func (x *Timestamp) ProtoReflect() protoreflect.Message

func (*Timestamp) Reset

func (x *Timestamp) Reset()

func (*Timestamp) SizeVT

func (m *Timestamp) SizeVT() (n int)

func (*Timestamp) String

func (x *Timestamp) String() string

func (*Timestamp) ToRFC3339

func (t *Timestamp) ToRFC3339() string

ToRFC3339 formats the timestamp as RFC3339

func (*Timestamp) ToTime

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

ToTime converts the Timestamp to a time.Time

func (*Timestamp) UnmarshalJSON

func (t *Timestamp) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals json. Supports string (unix milliseconds large value or RFC3339 timestamp), number (unix milliseconds)

func (*Timestamp) UnmarshalVT

func (m *Timestamp) UnmarshalVT(dAtA []byte) error

func (*Timestamp) Validate

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

Validate checks the timestamp.