date

Documentation

Overview

Package date provides time.Time derivatives that conform to the Swagger.io (https://swagger.io/) defined date formats: Date and DateTime. Both types may, in most cases, be used in lieu of time.Time types. And both convert to time.Time through a ToTime method.

Index

• type Date
  • func ParseDate(date string) (d Date, err error)
  • func (d Date) MarshalBinary() ([]byte, error)
  • func (d Date) MarshalJSON() (json []byte, err error)
  • func (d Date) MarshalText() (text []byte, err error)
  • func (d Date) String() string
  • func (d Date) ToTime() time.Time
  • func (d *Date) UnmarshalBinary(data []byte) error
  • func (d *Date) UnmarshalJSON(data []byte) (err error)
  • func (d *Date) UnmarshalText(data []byte) (err error)
• type Time
  • func ParseTime(date string) (d Time, err error)
  • func (d Time) MarshalBinary() ([]byte, error)
  • func (d Time) MarshalJSON() (json []byte, err error)
  • func (d Time) MarshalText() (text []byte, err error)
  • func (d Time) String() string
  • func (d Time) ToTime() time.Time
  • func (d *Time) UnmarshalBinary(data []byte) error
  • func (d *Time) UnmarshalJSON(data []byte) (err error)
  • func (d *Time) UnmarshalText(data []byte) (err error)

Examples

• Date
• Date.MarshalBinary
• Date.MarshalJSON
• Date.MarshalText
• Date.UnmarshalBinary
• Date.UnmarshalJSON
• Date.UnmarshalText
• ParseDate
• ParseTime
• Time.MarshalBinary
• Time.MarshalJSON
• Time.MarshalText
• Time.UnmarshalBinary
• Time.UnmarshalJSON
• Time.UnmarshalText

Types

type Date

type Date struct {
	time.Time
}

Date defines a type similar to time.Time but assumes a layout of RFC3339 full-date (i.e., 2006-01-02).

Example

d, _ := ParseDate("2001-02-03")
t, _ := time.Parse(time.RFC3339, "2001-02-04T00:00:00Z")

// Date acts as time.Time when the receiver
if d.Before(t) {
	fmt.Printf("Before ")
} else {
	fmt.Printf("After ")
}

// Convert Date when needing a time.Time
if t.After(d.ToTime()) {
	fmt.Printf("After")
} else {
	fmt.Printf("Before")
}

Output:

Before After

func ParseDate

func ParseDate(date string) (d Date, err error)

ParseDate create a new Date from the passed string.

Example

d, _ := ParseDate("2001-02-03")
fmt.Println(d)

Output:

2001-02-03

func (Date) MarshalBinary

func (d Date) MarshalBinary() ([]byte, error)

MarshalBinary preserves the Date as a byte array conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

d, _ := ParseDate("2001-02-03")
t, _ := d.MarshalBinary()
fmt.Println(string(t))

Output:

2001-02-03

func (Date) MarshalJSON

func (d Date) MarshalJSON() (json []byte, err error)

MarshalJSON preserves the Date as a JSON string conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

d, _ := ParseDate("2001-02-03")
j, _ := json.Marshal(d)
fmt.Println(string(j))

Output:

"2001-02-03"

func (Date) MarshalText

func (d Date) MarshalText() (text []byte, err error)

MarshalText preserves the Date as a byte array conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

d, _ := ParseDate("2001-02-03")
t, _ := d.MarshalText()
fmt.Println(string(t))

Output:

2001-02-03

func (Date) String

func (d Date) String() string

String returns the Date formatted as an RFC3339 full-date string (i.e., 2006-01-02).

func (Date) ToTime

func (d Date) ToTime() time.Time

ToTime returns a Date as a time.Time

func (*Date) UnmarshalBinary

func (d *Date) UnmarshalBinary(data []byte) error

UnmarshalBinary reconstitutes a Date saved as a byte array conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

d := Date{}
t := "2001-02-03"

err := d.UnmarshalBinary([]byte(t))
if err != nil {
	fmt.Println(err)
}
fmt.Println(d)

Output:

2001-02-03

func (*Date) UnmarshalJSON

func (d *Date) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON reconstitutes the Date from a JSON string conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

var d struct {
	Date Date `json:"date"`
}
j := `{
    "date" : "2001-02-03"
  }`

err := json.Unmarshal([]byte(j), &d)
if err != nil {
	fmt.Println(err)
}
fmt.Println(d.Date)

Output:

2001-02-03

func (*Date) UnmarshalText

func (d *Date) UnmarshalText(data []byte) (err error)

UnmarshalText reconstitutes a Date saved as a byte array conforming to RFC3339 full-date (i.e., 2006-01-02).

Example

d := Date{}
t := "2001-02-03"

err := d.UnmarshalText([]byte(t))
if err != nil {
	fmt.Println(err)
}
fmt.Println(d)

Output:

2001-02-03

type Time

type Time struct {
	time.Time
}

Time defines a type similar to time.Time but assumes a layout of RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

func ParseTime

func ParseTime(date string) (d Time, err error)

ParseTime creates a new Time from the passed string.

Example

d, _ := ParseTime("2001-02-03T04:05:06Z")
fmt.Println(d)

Output:

2001-02-03T04:05:06Z

func (Time) MarshalBinary

func (d Time) MarshalBinary() ([]byte, error)

MarshalBinary preserves the Time as a byte array conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

d, _ := ParseTime("2001-02-03T04:05:06Z")
t, _ := d.MarshalBinary()
fmt.Println(string(t))

Output:

2001-02-03T04:05:06Z

func (Time) MarshalJSON

func (d Time) MarshalJSON() (json []byte, err error)

MarshalJSON preserves the Time as a JSON string conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

d, _ := ParseTime("2001-02-03T04:05:06Z")
j, _ := json.Marshal(d)
fmt.Println(string(j))

Output:

"2001-02-03T04:05:06Z"

func (Time) MarshalText

func (d Time) MarshalText() (text []byte, err error)

MarshalText preserves the Time as a byte array conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

d, _ := ParseTime("2001-02-03T04:05:06Z")
t, _ := d.MarshalText()
fmt.Println(string(t))

Output:

2001-02-03T04:05:06Z

func (Time) String

func (d Time) String() string

String returns the Time formatted as an RFC3339 date-time string (i.e., 2006-01-02T15:04:05Z).

func (Time) ToTime

func (d Time) ToTime() time.Time

ToTime returns a Time as a time.Time

func (*Time) UnmarshalBinary

func (d *Time) UnmarshalBinary(data []byte) error

UnmarshalBinary reconstitutes a Time saved as a byte array conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

d := Time{}
t := "2001-02-03T04:05:06Z"

err := d.UnmarshalBinary([]byte(t))
if err != nil {
	fmt.Println(err)
}
fmt.Println(d)

Output:

2001-02-03T04:05:06Z

func (*Time) UnmarshalJSON

func (d *Time) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON reconstitutes the Time from a JSON string conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

var d struct {
	Time Time `json:"datetime"`
}
j := `{
    "datetime" : "2001-02-03T04:05:06Z"
  }`

err := json.Unmarshal([]byte(j), &d)
if err != nil {
	fmt.Println(err)
}
fmt.Println(d.Time)

Output:

2001-02-03T04:05:06Z

func (*Time) UnmarshalText

func (d *Time) UnmarshalText(data []byte) (err error)

UnmarshalText reconstitutes a Time saved as a byte array conforming to RFC3339 date-time (i.e., 2006-01-02T15:04:05Z).

Example

d := Time{}
t := "2001-02-03T04:05:06Z"

err := d.UnmarshalText([]byte(t))
if err != nil {
	fmt.Println(err)
}
fmt.Println(d)

Output:

2001-02-03T04:05:06Z