Struct Timestamp

Source

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

Expand description

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

§Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

Instant now = Instant.now();

Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

§JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Fields§

§seconds: i64

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

§nanos: i32

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

Struct Timestamp Copy item path

§Examples

§JSON Mapping

Fields§

Implementations§

impl Timestamp

pub fn format(&self, string: &str) -> Result<String, TimestampError>

pub fn as_datetime_utc(&self) -> Result<DateTime<Utc>, TimestampError>

impl Timestamp

pub fn now() -> Self

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

pub fn is_within_range_from_now(&self, range: Duration) -> bool

pub fn is_within_future_range(&self, range: Duration) -> bool

pub fn is_within_past_range(&self, range: Duration) -> bool

pub fn is_future(&self) -> bool

pub fn is_past(&self) -> bool

impl Timestamp

pub fn normalize(&mut self)

pub fn try_normalize(self) -> Result<Timestamp, Timestamp>

pub fn normalized(&self) -> Self

pub fn date(year: i64, month: u8, day: u8) -> Result<Timestamp, TimestampError>

pub fn date_time( year: i64, month: u8, day: u8, hour: u8, minute: u8, second: u8, ) -> Result<Timestamp, TimestampError>

pub fn date_time_nanos( year: i64, month: u8, day: u8, hour: u8, minute: u8, second: u8, nanos: u32, ) -> Result<Timestamp, TimestampError>

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 Clone for Timestamp

fn clone(&self) -> Timestamp

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

impl Debug for Timestamp

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

impl Default for Timestamp

fn default() -> Self

impl<'de> Deserialize<'de> for Timestamp

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

impl Display for Timestamp

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

impl From<DateTime<Utc>> for Timestamp

fn from(datetime: DateTime<Utc>) -> Self

impl From<SystemTime> for Timestamp

fn from(system_time: SystemTime) -> Timestamp

impl FromStr for Timestamp

type Err = TimestampError

fn from_str(s: &str) -> Result<Timestamp, TimestampError>

impl Hash for Timestamp

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 Timestamp

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 Name for Timestamp

const PACKAGE: &'static str = PACKAGE_PREFIX

const NAME: &'static str = "Timestamp"

fn type_url() -> String

fn full_name() -> String

impl Ord for Timestamp

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

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

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

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

impl PartialEq for Timestamp

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

Struct Timestamp

fn deserialize<D>(deserializer: D) -> Result<Self, 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,

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> AnyExt for T
where T: Any + ?Sized,

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,