Skip to main content

buffa_types/generated/
google.protobuf.timestamp.rs

1// @generated by buffa-codegen. DO NOT EDIT.
2// source: google/protobuf/timestamp.proto
3
4/// A Timestamp represents a point in time independent of any time zone or local
5/// calendar, encoded as a count of seconds and fractions of seconds at
6/// nanosecond resolution. The count is relative to an epoch at UTC midnight on
7/// January 1, 1970, in the proleptic Gregorian calendar which extends the
8/// Gregorian calendar backwards to year one.
9///
10/// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
11/// second table is needed for interpretation, using a \[24-hour linear
12/// smear\](<https://developers.google.com/time/smear>).
13///
14/// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
15/// restricting to that range, we ensure that we can convert to and from \[RFC
16/// 3339\](<https://www.ietf.org/rfc/rfc3339.txt>) date strings.
17///
18/// # Examples
19///
20/// Example 1: Compute Timestamp from POSIX `time()`.
21///
22/// ```text
23/// Timestamp timestamp;
24/// timestamp.set_seconds(time(NULL));
25/// timestamp.set_nanos(0);
26/// ```
27///
28/// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
29///
30/// ```text
31/// struct timeval tv;
32/// gettimeofday(&tv, NULL);
33///
34/// Timestamp timestamp;
35/// timestamp.set_seconds(tv.tv_sec);
36/// timestamp.set_nanos(tv.tv_usec * 1000);
37/// ```
38///
39/// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
40///
41/// ```text
42/// FILETIME ft;
43/// GetSystemTimeAsFileTime(&ft);
44/// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
45///
46/// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
47/// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
48/// Timestamp timestamp;
49/// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
50/// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
51/// ```
52///
53/// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
54///
55/// ```text
56/// long millis = System.currentTimeMillis();
57///
58/// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
59///     .setNanos((int) ((millis % 1000) * 1000000)).build();
60/// ```
61///
62/// Example 5: Compute Timestamp from Java `Instant.now()`.
63///
64/// ```text
65/// Instant now = Instant.now();
66///
67/// Timestamp timestamp =
68///     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
69///         .setNanos(now.getNano()).build();
70/// ```
71///
72/// Example 6: Compute Timestamp from current time in Python.
73///
74/// ```text
75/// timestamp = Timestamp()
76/// timestamp.GetCurrentTime()
77/// ```
78///
79/// # JSON Mapping
80///
81/// In JSON format, the Timestamp type is encoded as a string in the
82/// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
83/// format is "{year}-{month}-{day}T{hour}:{min}:{sec}\[.{frac_sec}\]Z"
84/// where {year} is always expressed using four digits while {month}, {day},
85/// {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
86/// seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
87/// are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
88/// is required. A proto3 JSON serializer should always use UTC (as indicated by
89/// "Z") when printing the Timestamp type and a proto3 JSON parser should be
90/// able to accept both UTC and other timezones (as indicated by an offset).
91///
92/// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
93/// 01:30 UTC on January 15, 2017.
94///
95/// In JavaScript, one can convert a Date object to this format using the
96/// standard
97/// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
98/// method. In Python, a standard `datetime.datetime` object can be converted
99/// to this format using
100/// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
101/// the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
102/// the Joda Time's \[`ISODateTimeFormat.dateTime()`\](
103/// <http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime(>)
104/// ) to obtain a formatter capable of generating timestamps in this format.
105#[derive(Clone, PartialEq, Default)]
106#[cfg_attr(feature = "arbitrary", derive(::arbitrary::Arbitrary))]
107pub struct Timestamp {
108    /// Represents seconds of UTC time since Unix epoch
109    /// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
110    /// 9999-12-31T23:59:59Z inclusive.
111    ///
112    /// Field 1: `seconds`
113    pub seconds: i64,
114    /// Non-negative fractions of a second at nanosecond resolution. Negative
115    /// second values with fractions must still have non-negative nanos values
116    /// that count forward in time. Must be from 0 to 999,999,999
117    /// inclusive.
118    ///
119    /// Field 2: `nanos`
120    pub nanos: i32,
121    #[doc(hidden)]
122    pub __buffa_unknown_fields: ::buffa::UnknownFields,
123}
124impl ::core::fmt::Debug for Timestamp {
125    fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
126        f.debug_struct("Timestamp")
127            .field("seconds", &self.seconds)
128            .field("nanos", &self.nanos)
129            .finish()
130    }
131}
132impl Timestamp {
133    /// Protobuf type URL for this message, for use with `Any::pack` and
134    /// `Any::unpack_if`.
135    ///
136    /// Format: `type.googleapis.com/<fully.qualified.TypeName>`
137    pub const TYPE_URL: &'static str = "type.googleapis.com/google.protobuf.Timestamp";
138}
139impl ::buffa::DefaultInstance for Timestamp {
140    fn default_instance() -> &'static Self {
141        static VALUE: ::buffa::__private::OnceBox<Timestamp> = ::buffa::__private::OnceBox::new();
142        VALUE.get_or_init(|| ::buffa::alloc::boxed::Box::new(Self::default()))
143    }
144}
145impl ::buffa::MessageName for Timestamp {
146    const PACKAGE: &'static str = "google.protobuf";
147    const NAME: &'static str = "Timestamp";
148    const FULL_NAME: &'static str = "google.protobuf.Timestamp";
149    const TYPE_URL: &'static str = "type.googleapis.com/google.protobuf.Timestamp";
150}
151impl ::buffa::Message for Timestamp {
152    /// Returns the total encoded size in bytes.
153    ///
154    /// The result is a `u32`; the protobuf specification requires all
155    /// messages to fit within 2 GiB (2,147,483,647 bytes), so a
156    /// compliant message will never overflow this type.
157    #[allow(clippy::let_and_return)]
158    fn compute_size(&self, _cache: &mut ::buffa::SizeCache) -> u32 {
159        #[allow(unused_imports)]
160        use ::buffa::Enumeration as _;
161        let mut size = 0u32;
162        if self.seconds != 0i64 {
163            size += 1u32 + ::buffa::types::int64_encoded_len(self.seconds) as u32;
164        }
165        if self.nanos != 0i32 {
166            size += 1u32 + ::buffa::types::int32_encoded_len(self.nanos) as u32;
167        }
168        size += self.__buffa_unknown_fields.encoded_len() as u32;
169        size
170    }
171    fn write_to(
172        &self,
173        _cache: &mut ::buffa::SizeCache,
174        buf: &mut impl ::buffa::bytes::BufMut,
175    ) {
176        #[allow(unused_imports)]
177        use ::buffa::Enumeration as _;
178        if self.seconds != 0i64 {
179            ::buffa::encoding::Tag::new(1u32, ::buffa::encoding::WireType::Varint)
180                .encode(buf);
181            ::buffa::types::encode_int64(self.seconds, buf);
182        }
183        if self.nanos != 0i32 {
184            ::buffa::encoding::Tag::new(2u32, ::buffa::encoding::WireType::Varint)
185                .encode(buf);
186            ::buffa::types::encode_int32(self.nanos, buf);
187        }
188        self.__buffa_unknown_fields.write_to(buf);
189    }
190    fn merge_field(
191        &mut self,
192        tag: ::buffa::encoding::Tag,
193        buf: &mut impl ::buffa::bytes::Buf,
194        depth: u32,
195    ) -> ::core::result::Result<(), ::buffa::DecodeError> {
196        #[allow(unused_imports)]
197        use ::buffa::bytes::Buf as _;
198        #[allow(unused_imports)]
199        use ::buffa::Enumeration as _;
200        match tag.field_number() {
201            1u32 => {
202                if tag.wire_type() != ::buffa::encoding::WireType::Varint {
203                    return ::core::result::Result::Err(::buffa::DecodeError::WireTypeMismatch {
204                        field_number: 1u32,
205                        expected: 0u8,
206                        actual: tag.wire_type() as u8,
207                    });
208                }
209                self.seconds = ::buffa::types::decode_int64(buf)?;
210            }
211            2u32 => {
212                if tag.wire_type() != ::buffa::encoding::WireType::Varint {
213                    return ::core::result::Result::Err(::buffa::DecodeError::WireTypeMismatch {
214                        field_number: 2u32,
215                        expected: 0u8,
216                        actual: tag.wire_type() as u8,
217                    });
218                }
219                self.nanos = ::buffa::types::decode_int32(buf)?;
220            }
221            _ => {
222                self.__buffa_unknown_fields
223                    .push(::buffa::encoding::decode_unknown_field(tag, buf, depth)?);
224            }
225        }
226        ::core::result::Result::Ok(())
227    }
228    fn clear(&mut self) {
229        self.seconds = 0i64;
230        self.nanos = 0i32;
231        self.__buffa_unknown_fields.clear();
232    }
233}
234impl ::buffa::ExtensionSet for Timestamp {
235    const PROTO_FQN: &'static str = "google.protobuf.Timestamp";
236    fn unknown_fields(&self) -> &::buffa::UnknownFields {
237        &self.__buffa_unknown_fields
238    }
239    fn unknown_fields_mut(&mut self) -> &mut ::buffa::UnknownFields {
240        &mut self.__buffa_unknown_fields
241    }
242}
243impl ::buffa::text::TextFormat for Timestamp {
244    fn encode_text(
245        &self,
246        enc: &mut ::buffa::text::TextEncoder<'_>,
247    ) -> ::core::fmt::Result {
248        #[allow(unused_imports)]
249        use ::buffa::Enumeration as _;
250        if self.seconds != 0i64 {
251            enc.write_field_name("seconds")?;
252            enc.write_i64(self.seconds)?;
253        }
254        if self.nanos != 0i32 {
255            enc.write_field_name("nanos")?;
256            enc.write_i32(self.nanos)?;
257        }
258        enc.write_unknown_fields(&self.__buffa_unknown_fields)?;
259        ::core::result::Result::Ok(())
260    }
261    fn merge_text(
262        &mut self,
263        dec: &mut ::buffa::text::TextDecoder<'_>,
264    ) -> ::core::result::Result<(), ::buffa::text::ParseError> {
265        #[allow(unused_imports)]
266        use ::buffa::Enumeration as _;
267        while let ::core::option::Option::Some(__name) = dec.read_field_name()? {
268            match __name {
269                "seconds" => self.seconds = dec.read_i64()?,
270                "nanos" => self.nanos = dec.read_i32()?,
271                _ => dec.skip_value()?,
272            }
273        }
274        ::core::result::Result::Ok(())
275    }
276}
277#[doc(hidden)]
278pub const __TIMESTAMP_TEXT_ANY: ::buffa::type_registry::TextAnyEntry = ::buffa::type_registry::TextAnyEntry {
279    type_url: "type.googleapis.com/google.protobuf.Timestamp",
280    text_encode: ::buffa::type_registry::any_encode_text::<Timestamp>,
281    text_merge: ::buffa::type_registry::any_merge_text::<Timestamp>,
282};