durationpb
package
This package is not in the latest version of its module.
Details
Validgo.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
Links
Open Source Insights
Documentation¶
Overview¶
Package durationpb contains generated types for google/protobuf/duration.proto.
The Duration message represents a signed span of time.
Conversion to a Go Duration¶
The AsDuration method can be used to convert a Duration message to astandard Go time.Duration value:
d := dur.AsDuration()... // make use of d as a time.Duration
Converting to a time.Duration is a common operation so that the extensiveset of time-based operations provided by the time package can be leveraged.Seehttps://golang.org/pkg/time for more information.
The AsDuration method performs the conversion on a best-effort basis.Durations with denormal values (e.g., nanoseconds beyond -99999999 and+99999999, inclusive; or seconds and nanoseconds with opposite signs)are normalized during the conversion to a time.Duration. To manually check forinvalid Duration per the documented limitations in duration.proto,additionally call the CheckValid method:
if err := dur.CheckValid(); err != nil {... // handle error}Note that the documented limitations in duration.proto does not protect aDuration from overflowing the representable range of a time.Duration in Go.The AsDuration method uses saturation arithmetic such that an overflow clampsthe resulting value to the closest representable value (e.g., math.MaxInt64for positive overflow and math.MinInt64 for negative overflow).
Conversion from a Go Duration¶
The durationpb.New function can be used to construct a Duration messagefrom a standard Go time.Duration value:
dur := durationpb.New(d)... // make use of d as a *durationpb.Duration
Index¶
- Variables
- type Duration
- func (x *Duration) AsDuration() time.Duration
- func (x *Duration) CheckValid() error
- func (*Duration) Descriptor() ([]byte, []int)deprecated
- func (x *Duration) GetNanos() int32
- func (x *Duration) GetSeconds() int64
- func (x *Duration) IsValid() bool
- func (*Duration) ProtoMessage()
- func (x *Duration) ProtoReflect() protoreflect.Message
- func (x *Duration) Reset()
- func (x *Duration) String() string
Constants¶
This section is empty.
Variables¶
var File_google_protobuf_duration_protoprotoreflect.FileDescriptorFunctions¶
This section is empty.
Types¶
typeDuration¶
type Duration struct {// Signed seconds of the span of time. Must be from -315,576,000,000// to +315,576,000,000 inclusive. Note: these bounds are computed from:// 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 yearsSecondsint64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`// Signed fractions of a second at nanosecond resolution of the span// of time. Durations less than one second are represented with a 0// `seconds` field and a positive or negative `nanos` field. For durations// of one second or more, a non-zero value for the `nanos` field must be// of the same sign as the `seconds` field. Must be from -999,999,999// to +999,999,999 inclusive.Nanosint32 `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`// contains filtered or unexported fields}A Duration represents a signed, fixed-length span of time representedas a count of seconds and fractions of seconds at nanosecondresolution. It is independent of any calendar and concepts like "day"or "month". It is related to Timestamp in that the difference betweentwo Timestamp values is a Duration and it can be added or subtractedfrom a Timestamp. Range is approximately +-10,000 years.
Examples¶
Example 1: Compute Duration from two Timestamps in pseudo code.
Timestamp start = ...;Timestamp end = ...;Duration duration = ...;duration.seconds = end.seconds - start.seconds;duration.nanos = end.nanos - start.nanos;if (duration.seconds < 0 && duration.nanos > 0) { duration.seconds += 1; duration.nanos -= 1000000000;} else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000;}Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
Timestamp start = ...;Duration duration = ...;Timestamp end = ...;end.seconds = start.seconds + duration.seconds;end.nanos = start.nanos + duration.nanos;if (end.nanos < 0) { end.seconds -= 1; end.nanos += 1000000000;} else if (end.nanos >= 1000000000) { end.seconds += 1; end.nanos -= 1000000000;}Example 3: Compute Duration from datetime.timedelta in Python.
td = datetime.timedelta(days=3, minutes=10)duration = Duration()duration.FromTimedelta(td)
JSON Mapping¶
In JSON format, the Duration type is encoded as a string rather than anobject, where the string ends in the suffix "s" (indicating seconds) andis preceded by the number of seconds, with nanoseconds expressed asfractional seconds. For example, 3 seconds with 0 nanoseconds should beencoded in JSON format as "3s", while 3 seconds and 1 nanosecond shouldbe expressed in JSON format as "3.000000001s", and 3 seconds and 1microsecond should be expressed in JSON format as "3.000001s".
func (*Duration)AsDuration¶added inv1.25.0
AsDuration converts x to a time.Duration,returning the closest duration value in the event of overflow.
func (*Duration)CheckValid¶added inv1.25.0
CheckValid returns an error if the duration is invalid.In particular, it checks whether the value is within the range of-10000 years to +10000 years inclusive.An error is reported for a nil Duration.
func (*Duration)Descriptordeprecated
func (*Duration)GetSeconds¶
func (*Duration)IsValid¶added inv1.25.0
IsValid reports whether the duration is valid.It is equivalent to CheckValid == nil.
func (*Duration)ProtoMessage¶
func (*Duration) ProtoMessage()
func (*Duration)ProtoReflect¶
func (x *Duration) ProtoReflect()protoreflect.Message
Source Files