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         "strings"
  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 returns a format similar to (time.Duration)String() but with
  32 // "0m" and "0s" removed: e.g., "1h" instead of "1h0m0s".
  33 func (d Duration) String() string {
  34         s := time.Duration(d).String()
  35         s = strings.Replace(s, "m0s", "m", 1)
  36         s = strings.Replace(s, "h0m", "h", 1)
  37         return s
  38 }
  39
  40 // Duration returns a time.Duration.
  41 func (d Duration) Duration() time.Duration {
  42         return time.Duration(d)
  43 }
  44
  45 // Set implements the flag.Value interface and sets the duration value by using time.ParseDuration to parse the string.
  46 func (d *Duration) Set(s string) error {
  47         dur, err := time.ParseDuration(s)
  48         *d = Duration(dur)
  49         return err
  50 }