Struct Duration

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

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.

Implementations

impl Duration

pub fn normalize(&mut self)

Normalizes the duration to a canonical format.

Based on google::protobuf::util::CreateNormalized.

pub fn normalized(&self) -> Self

Returns a normalized copy of the duration to a canonical format.

Based on google::protobuf::util::CreateNormalized.

impl Duration

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

impl Duration

pub fn is_negative(&self) -> bool

Whether the duration is negative or not.

pub fn get_data(&self) -> DurationData

Creates a DurationData instance.

Trait Implementations

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

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for &Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Duration

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

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Self

Returns the “default value” for a type.

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

Available on crate features serde and chrono only.

fn deserialize<D>(deserializer: D) -> Result<Duration, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Duration

Formats a duration in human readable form. (e.g. “2 days 15 hours 12 minutes and 15 seconds”)

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

Formats the value using the given formatter.

impl From<TimeDelta> for Duration

Available on crate feature chrono only.

fn from(value: TimeDelta) -> Self

Converts to this type from the input type.

impl FromStr for Duration

type Err = DurationError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Duration

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for Duration

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

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

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

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

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for Duration

const PACKAGE: &'static str = PACKAGE_PREFIX

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

const NAME: &'static str = "Duration"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

impl Ord for Duration

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Duration

fn eq(&self, other: &Duration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Duration

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Duration

Available on crate features serde and chrono only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

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

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Duration> for &'a Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl ToTokens for Duration

Available on crate feature totokens only.

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl TryFrom<Duration> for Duration

fn try_from(duration: Duration) -> Result<Duration, DurationError>

Converts a std::time::Duration to a Duration, failing if the duration is too large.

type Error = DurationError

The type returned in the event of a conversion error.

impl TryFrom<Duration> for Duration

fn try_from(duration: Duration) -> Result<Duration, DurationError>

Converts a Duration to a std::time::Duration, failing if the duration is negative.

type Error = DurationError

The type returned in the event of a conversion error.

impl TryFrom<Duration> for TimeDelta

Available on crate feature chrono only.

type Error = DurationError

The type returned in the event of a conversion error.

fn try_from(value: Duration) -> Result<TimeDelta, DurationError>

Performs the conversion.

impl TryFrom<Duration> for Value

Available on crate features chrono and cel only.

type Error = CelConversionError

The type returned in the event of a conversion error.

fn try_from(value: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration