Struct Duration

Source

pub struct Duration {
    pub seconds: i64,
    pub nanos: i32,
}

Expand description

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”.

Fields§

§seconds: i64

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

§nanos: i32

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.

Struct Duration Copy item path

§Examples

§JSON Mapping

Fields§

Implementations§

impl Duration

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

impl Duration

pub fn get_data(&self) -> DurationData

impl Duration

pub fn checked_mul(&self, rhs: i64) -> Option<Self>

pub fn checked_add(&self, other: &Duration) -> Option<Self>

pub fn checked_sub(&self, other: &Duration) -> Option<Self>

pub fn checked_div(&self, rhs: i64) -> Option<Self>

impl Duration

pub fn is_negative(&self) -> bool

pub fn new(seconds: i64, nanos: i32) -> Self

Trait Implementations§

impl<'b> Add<&'b Duration> for &Timestamp

type Output = Timestamp

fn add(self, rhs: &'b Duration) -> Self::Output

impl<'b> Add<&'b Duration> for Timestamp

type Output = Timestamp

fn add(self, rhs: &'b Duration) -> Self::Output

impl Add<Duration> for &Timestamp

type Output = Timestamp

fn add(self, rhs: Duration) -> Self::Output

impl Add<Duration> for Timestamp

type Output = Timestamp

fn add(self, rhs: Duration) -> Self::Output

impl Add for Duration

type Output = Duration

fn add(self, rhs: Self) -> Self::Output

impl Clone for Duration

fn clone(&self) -> Duration

fn clone_from(&mut self, source: &Self)

impl Debug for Duration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Default for Duration

fn default() -> Self

impl<'de> Deserialize<'de> for Duration

fn deserialize<D>(deserializer: D) -> Result<Duration, D::Error>where D: Deserializer<'de>,

impl Display for Duration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Div<i32> for Duration

type Output = Duration

fn div(self, rhs: i32) -> Self

impl Div<i64> for Duration

type Output = Duration

fn div(self, rhs: i64) -> Self

impl From<TimeDelta> for Duration

fn from(value: TimeDelta) -> Self

impl FromStr for Duration

type Err = DurationError

fn from_str(s: &str) -> Result<Duration, DurationError>

impl Hash for Duration

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Message for Duration

fn encoded_len(&self) -> usize

fn clear(&mut self)

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where Self: Sized,

fn encode_to_vec(&self) -> Vec<u8> ⓘwhere Self: Sized,

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>where Self: Sized,

fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘwhere Self: Sized,

fn decode(buf: impl Buf) -> Result<Self, DecodeError>where Self: Default,

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where Self: Default,

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where Self: Sized,

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where Self: Sized,

impl Mul<i32> for Duration

type Output = Duration

fn mul(self, rhs: i32) -> Self

impl Mul<i64> for Duration

type Output = Duration

fn mul(self, rhs: i64) -> Self

impl Name for Duration

const PACKAGE: &'static str = PACKAGE_PREFIX

const NAME: &'static str = "Duration"

fn type_url() -> String

Struct Duration

fn deserialize<D>(deserializer: D) -> Result<Duration, D::Error>
where D: Deserializer<'de>,

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

fn encode_to_vec(&self) -> Vec<u8> ⓘ
where Self: Sized,

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘ
where Self: Sized,

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

fn into_token_stream(self) -> TokenStream
where Self: Sized,