duration

README

iso8601duration

ISO8601 Duration Parser for Golang

Adapted from http://github.com/BrianHicks/finch

Documentation

Overview

Package duration provides a partial implementation of ISO8601 durations. (no months)

Index

• Variables
• type Duration
  • func FromString(dur string) (*Duration, error)
  • func (d *Duration) HasTimePart() bool
  • func (d *Duration) String() string
  • func (d *Duration) ToDuration() time.Duration

Variables

var (
	// ErrBadFormat is returned when parsing fails
	ErrBadFormat = errors.New("bad format string")

	// ErrNoMonth is raised when a month is in the format string
	ErrNoMonth = errors.New("no months allowed")
)

Types

type Duration

type Duration struct {
	Years   int
	Months  int
	Weeks   int
	Days    int
	Hours   int
	Minutes int
	Seconds int
}

func FromString

func FromString(dur string) (*Duration, error)

func (*Duration) HasTimePart

func (d *Duration) HasTimePart() bool

func (*Duration) String

func (d *Duration) String() string

String prints out the value passed in. It's not strictly according to the ISO spec, but it's pretty close. In particular, to completely conform it would need to round up to the next largest unit. 61 seconds to 1 minute 1 second, for example. It would also need to disallow weeks mingling with other units.

func (*Duration) ToDuration

func (d *Duration) ToDuration() time.Duration