lwtime

Documentation

Overview

A simple relative and natural time package

A simple relative and natural time package

Index

• Constants
• func ParseNatural(n string) (time.Time, time.Time, error)
• func ParseRelative(s string) (time.Time, error)
• type Epoch
  • func (epoch Epoch) Format(s string) string
  • func (epoch *Epoch) MarshalJSON() ([]byte, error)
  • func (epoch Epoch) ToTime() time.Time
  • func (epoch Epoch) UTC() time.Time
  • func (epoch *Epoch) UnmarshalJSON(b []byte) error
• type EpochString
  • func (epoch EpochString) Format(s string) string
  • func (epoch *EpochString) MarshalJSON() ([]byte, error)
  • func (epoch EpochString) ToTime() time.Time
  • func (epoch EpochString) UTC() time.Time
  • func (epoch *EpochString) UnmarshalJSON(b []byte) error
• type NanoTime
  • func (self NanoTime) Format(s string) string
  • func (self NanoTime) MarshalJSON() ([]byte, error)
  • func (self NanoTime) ToTime() time.Time
  • func (self NanoTime) UTC() time.Time
  • func (self *NanoTime) UnmarshalJSON(b []byte) (err error)
• type RFC1123Z
  • func (rfc RFC1123Z) Format(s string) string
  • func (rfc *RFC1123Z) MarshalJSON() ([]byte, error)
  • func (rfc RFC1123Z) ToTime() time.Time
  • func (rfc RFC1123Z) UTC() time.Time
  • func (rfc *RFC1123Z) UnmarshalJSON(b []byte) (err error)

Constants

const (
	Today     naturalAdjective = "today"
	Yesterday naturalAdjective = "yesterday"
	This      naturalAdjective = "this"
	Current   naturalAdjective = "current"
	Previous  naturalAdjective = "previous"
	Last      naturalAdjective = "last"
)

const (
	Year   relativeUnit = "y"
	Month  relativeUnit = "mon"
	Week   relativeUnit = "w"
	Day    relativeUnit = "d"
	Hour   relativeUnit = "h"
	Minute relativeUnit = "m"
	Second relativeUnit = "s"
)

const (
	RFC3339Milli = "2006-01-02T15:04:05.000Z"
)

Functions

func ParseNatural

func ParseNatural(n string) (time.Time, time.Time, error)

Parse the string representation of a Lacework natural time

start, end, err := lwtime.ParseNatural("this year")

if err != nil {
	...
}

func ParseRelative

func ParseRelative(s string) (time.Time, error)

Parse the string representation of a Lacework relative time

t, err := lwtime.ParseRelative("-1y@y")

if err != nil {
	...
}

Types

type Epoch

type Epoch time.Time

Epoch time type to parse the returned 13 digit time in milliseconds

func (Epoch) Format

func (epoch Epoch) Format(s string) string

func (*Epoch) MarshalJSON

func (epoch *Epoch) MarshalJSON() ([]byte, error)

func (Epoch) ToTime

func (epoch Epoch) ToTime() time.Time

A few format functions for printing and manipulating the custom date

func (Epoch) UTC

func (epoch Epoch) UTC() time.Time

func (*Epoch) UnmarshalJSON

func (epoch *Epoch) UnmarshalJSON(b []byte) error

implement Marshal and Unmarshal interfaces

type EpochString

type EpochString time.Time

EpochString time type to parse the returned 13 digit time in milliseconds Used instead of Epoch type when unmarshalling a json response where epoch time is a string

func (EpochString) Format

func (epoch EpochString) Format(s string) string

func (*EpochString) MarshalJSON

func (epoch *EpochString) MarshalJSON() ([]byte, error)

func (EpochString) ToTime

func (epoch EpochString) ToTime() time.Time

func (EpochString) UTC

func (epoch EpochString) UTC() time.Time

func (*EpochString) UnmarshalJSON

func (epoch *EpochString) UnmarshalJSON(b []byte) error

type NanoTime

type NanoTime time.Time

time type to parse the returned time with nano format

Example:

"START_TIME":"2020-08-20T01:00:00+0000"

func (NanoTime) Format

func (self NanoTime) Format(s string) string

func (NanoTime) MarshalJSON

func (self NanoTime) MarshalJSON() ([]byte, error)

func (NanoTime) ToTime

func (self NanoTime) ToTime() time.Time

A few format functions for printing and manipulating the custom date

func (NanoTime) UTC

func (self NanoTime) UTC() time.Time

func (*NanoTime) UnmarshalJSON

func (self *NanoTime) UnmarshalJSON(b []byte) (err error)

type RFC1123Z

type RFC1123Z time.Time

func (RFC1123Z) Format

func (rfc RFC1123Z) Format(s string) string

func (*RFC1123Z) MarshalJSON

func (rfc *RFC1123Z) MarshalJSON() ([]byte, error)

func (RFC1123Z) ToTime

func (rfc RFC1123Z) ToTime() time.Time

func (RFC1123Z) UTC

func (rfc RFC1123Z) UTC() time.Time

func (*RFC1123Z) UnmarshalJSON

func (rfc *RFC1123Z) UnmarshalJSON(b []byte) (err error)