iso8601

package module

v0.0.2 Latest Latest Go to latest Published: Oct 11, 2022 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitoa.ru/go-4devs/iso8601

Links

Open Source Insights

README ¶

iso8601

A fast ISO8601 duration parse and format for Go.

Documentation ¶

Index ¶

Variables
func FormatDuration(duration time.Duration) string
func ParseDuration(s string, opts ...Option) (time.Duration, error)
type Option
- func From(from func() time.Time) Option

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidDuration = errors.New("invalid duration")
	ErrMissingUnit     = errors.New("missing unit")
	ErrUnknownUnit     = errors.New("unknown unit")
	ErrOverflow        = errors.New("overflow")
	ErrLeadingInt      = errors.New("leading int")
)

Functions ¶

func FormatDuration ¶

func FormatDuration(duration time.Duration) string

FormatDuration returns a string representing the duration in the form "P1Y2M3DT4H5M6S". Leading zero units are omitted. The zero duration formats as PT0S.

Example ¶

package main

import (
	"fmt"
	"time"

	"gitoa.ru/go-4devs/iso8601"
)

func main() {
	second := iso8601.FormatDuration(time.Second)
	hours := iso8601.FormatDuration(time.Hour * 25)
	partOfSecond := iso8601.FormatDuration(time.Second / 5)

	fmt.Printf("%s = %s\n", time.Second, second)
	fmt.Printf("%s = %s\n", time.Hour*25, hours)
	fmt.Printf("%s = %s\n", time.Second/5, partOfSecond)
}

Output:

1s = PT1S
25h0m0s = P1DT1H
200ms = PT0.2S

func ParseDuration ¶

func ParseDuration(s string, opts ...Option) (time.Duration, error)

ParseDuration parses a duration string format P(n)Y(n)M(n)DT(n)H(n)M(n)S. use iso8601.From(time) when using the month and year, by default time.Now().

Example ¶

package main

import (
	"fmt"
	"time"

	"gitoa.ru/go-4devs/iso8601"
)

func main() {
	year2020 := time.Date(2020, 1, 1, 1, 1, 1, 1, time.UTC)
	second, errSecond := iso8601.ParseDuration("PT1S")
	hours, errHours := iso8601.ParseDuration("P1DT1H")
	partOfSecond, errPartOfSecond := iso8601.ParseDuration("PT0.2S")
	yearFromZeroTime, errYearFromZeroTime := iso8601.ParseDuration("P1Y1M1D", iso8601.From(func() time.Time { return time.Time{} }))
	yearFrom2020, errYearFrom2020 := iso8601.ParseDuration("P1Y1M1D", iso8601.From(func() time.Time { return year2020 }))

	fmt.Printf("PT1S = %s(%v)\n", second, errSecond)
	fmt.Printf("P1DT1H = %s(%v)\n", hours, errHours)
	fmt.Printf("PT0.2S = %s(%v)\n", partOfSecond, errPartOfSecond)
	fmt.Printf("P1Y1M1D(from %v) = %s(%v)\n", time.Time{}, yearFromZeroTime, errYearFromZeroTime)
	fmt.Printf("P1Y1M1D(form %v) = %s(%v)\n", year2020, yearFrom2020, errYearFrom2020)
}

Output:

PT1S = 1s(<nil>)
P1DT1H = 25h0m0s(<nil>)
PT0.2S = 200ms(<nil>)
P1Y1M1D(from 0001-01-01 00:00:00 +0000 UTC) = 9528h0m0s(<nil>)
P1Y1M1D(form 2020-01-01 01:01:01.000000001 +0000 UTC) = 9552h0m0s(<nil>)

Types ¶

type Option ¶

type Option func(*duration)

func From ¶

func From(from func() time.Time) Option

Source Files ¶

View all Source files

duration.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL