durationpb

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2024 License: BSD-3-Clause Imports: 9 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Duration

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 years
	Seconds int64 `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.
	Nanos int32 `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 represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from 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 an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

protobuf-go-lite:disable-text

func New

func New(d time.Duration) *Duration

New constructs a new Duration from the provided time.Duration.

func (*Duration) AsDuration

func (x *Duration) AsDuration() time.Duration

AsDuration converts x to a time.Duration, returning the closest duration value in the event of overflow.

func (*Duration) CheckValid

func (x *Duration) CheckValid() error

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) CloneMessageVT added in v0.2.1

func (m *Duration) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Duration) CloneVT added in v0.2.1

func (m *Duration) CloneVT() *Duration

func (*Duration) EqualMessageVT added in v0.2.1

func (this *Duration) EqualMessageVT(thatMsg any) bool

func (*Duration) EqualVT added in v0.2.1

func (this *Duration) EqualVT(that *Duration) bool

func (*Duration) GetNanos

func (x *Duration) GetNanos() int32

func (*Duration) GetSeconds

func (x *Duration) GetSeconds() int64

func (*Duration) IsValid

func (x *Duration) IsValid() bool

IsValid reports whether the duration is valid. It is equivalent to CheckValid == nil.

func (*Duration) MarshalJSON added in v0.3.0

func (x *Duration) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Duration to JSON.

func (*Duration) MarshalProtoJSON added in v0.3.0

func (x *Duration) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals a Duration to JSON.

func (*Duration) MarshalProtoText added in v0.5.0

func (d *Duration) MarshalProtoText() string

MarshalProtoText formats the Duration to a proto text string.

func (*Duration) MarshalToSizedBufferVT added in v0.2.1

func (m *Duration) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Duration) MarshalToSizedBufferVTStrict added in v0.2.1

func (m *Duration) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)

func (*Duration) MarshalToVT added in v0.2.1

func (m *Duration) MarshalToVT(dAtA []byte) (int, error)

func (*Duration) MarshalToVTStrict added in v0.2.1

func (m *Duration) MarshalToVTStrict(dAtA []byte) (int, error)

func (*Duration) MarshalVT added in v0.2.1

func (m *Duration) MarshalVT() (dAtA []byte, err error)

func (*Duration) MarshalVTStrict added in v0.2.1

func (m *Duration) MarshalVTStrict() (dAtA []byte, err error)

func (*Duration) ProtoMessage

func (*Duration) ProtoMessage()

func (*Duration) Reset

func (x *Duration) Reset()

func (*Duration) SizeVT added in v0.2.1

func (m *Duration) SizeVT() (n int)

func (*Duration) String added in v0.1.1

func (d *Duration) String() string

String formats the duration to a string.

func (*Duration) UnmarshalJSON added in v0.4.0

func (x *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Duration from JSON.

func (*Duration) UnmarshalProtoJSON added in v0.4.0

func (x *Duration) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals a Duration from JSON.

func (*Duration) UnmarshalVT added in v0.2.1

func (m *Duration) UnmarshalVT(dAtA []byte) error

func (*Duration) UnmarshalVTUnsafe added in v0.2.1

func (m *Duration) UnmarshalVTUnsafe(dAtA []byte) error

Jump to

Keyboard shortcuts

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