sdk/go/arvados/duration.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 package arvados
   6
   7 import (
   8         "encoding/json"
   9         "fmt"
  10         "reflect"
  11         "time"
  12 )
  13
  14 // Duration is time.Duration but looks like "12s" in JSON, rather than
  15 // a number of nanoseconds.
  16 type Duration time.Duration
  17
  18 // UnmarshalJSON implements json.Unmarshaler
  19 func (d *Duration) UnmarshalJSON(data []byte) error {
  20         if data[0] == '"' {
  21                 return d.Set(string(data[1 : len(data)-1]))
  22         }
  23         return fmt.Errorf("duration must be given as a string like \"600s\" or \"1h30m\"")
  24 }
  25
  26 // MarshalJSON implements json.Marshaler
  27 func (d *Duration) MarshalJSON() ([]byte, error) {
  28         return json.Marshal(d.String())
  29 }
  30
  31 // String implements fmt.Stringer
  32 func (d Duration) String() string {
  33         return time.Duration(d).String()
  34 }
  35
  36 // Duration returns a time.Duration
  37 func (d Duration) Duration() time.Duration {
  38         return time.Duration(d)
  39 }
  40
  41 // Set sets the current duration by parsing the string using time.ParseDuration
  42 func (d *Duration) Set(s string) error {
  43         dur, err := time.ParseDuration(s)
  44         *d = Duration(dur)
  45         return err
  46 }
  47
  48 // DurationMapStructureDecodeHook can be used to create a decoder for arvados.duration when using mapstructure
  49 func DurationMapStructureDecodeHook() interface{} {
  50         return func(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error) {
  51                 var duration Duration
  52                 if f.Kind() != reflect.String || t != reflect.TypeOf(duration) {
  53                         return data, nil
  54                 }
  55
  56                 duration.Set(data.(string))
  57                 return duration, nil
  58         }
  59 }