Structureswift-protobuf 1.28.1SwiftProtobuf
Google_Protobuf_Timestamp
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.
timestamp.pb.swift:142struct Google_Protobuf_Timestamp
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.
Citizens in SwiftProtobuf
Conformances
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Message
The protocol which all generated protobuf messages implement.
Message
is the protocol type you should use whenever you need an argument or variable which holds “some message”.protocol Sendable
A type whose values can safely be passed across concurrency domains by copying.
Show implementation details (2)
Hide implementation details
protocol _MessageImplementationBase
Implementation base for all messages; not intended for client use.
protocol _ProtoNameProviding
SwiftProtobuf Internal: Common support looking up field names.
Type members
init(
) init(date: Date
) Creates a new
Google_Protobuf_Timestamp
initialized to the same time as the givenDate
.init(seconds: Int64, nanos: Int32
) Creates a new
Google_Protobuf_Timestamp
equal to the given number of seconds and nanoseconds.init(timeIntervalSince1970: TimeInterval
) Creates a new
Google_Protobuf_Timestamp
initialized relative to 00:00:00 UTC on 1 January 1970 by a given number of seconds.init(timeIntervalSinceReferenceDate: TimeInterval
) Creates a new
Google_Protobuf_Timestamp
initialized relative to 00:00:00 UTC on 1 January 2001 by a given number of seconds.static let protoMessageName: String
static func == (lhs: Google_Protobuf_Timestamp, rhs: Google_Protobuf_Timestamp
) -> Bool
Show implementation details (1)
Hide implementation details
Instance members
var date: Date
A
Date
initialized to the same time as the timestamp.var nanos: Int32
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.
var seconds: Int64
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.
var timeIntervalSince1970: TimeInterval
The interval between the timestamp and 00:00:00 UTC on 1 January 1970.
var timeIntervalSinceReferenceDate: TimeInterval
The interval between the timestamp and 00:00:00 UTC on 1 January 2001.
var unknownFields: UnknownStorage
func decodeMessage<D>(decoder: inout D
) throws func traverse<V>(visitor: inout V
) throws
Type features
init(jsonString: String, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init(jsonString: String, options: JSONDecodingOptions
) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init<Bytes>(jsonUTF8Bytes: Bytes, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(jsonUTF8Bytes: Bytes, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
Data
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
Data
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init(textFormatString: String, extensions: (any ExtensionMap)?
) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(textFormatString: String, options: TextFormatDecodingOptions, extensions: (any ExtensionMap)?
) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(unpackingAny: Google_Protobuf_Any, extensions: (any ExtensionMap)?, options: BinaryDecodingOptions
) throws Initialize this message from the provided
google.protobuf.Any
well-known type.static func array(fromJSONString: String, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array(fromJSONString: String, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array<Bytes>(fromJSONUTF8Bytes: Bytes, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytes
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array<Bytes>(fromJSONUTF8Bytes: Bytes, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytes
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
Data
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
Data
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func isPathValid(String
) -> Bool Checks whether the given path is valid for Message type.
static func jsonString<C>(from: C, options: JSONEncodingOptions
) throws -> String Returns a string containing the JSON serialization of the messages.
static func jsonUTF8Bytes<C, Bytes>(from: C, options: JSONEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
containing the UTF-8 JSON serialization of the messages.static func jsonUTF8Data<C>(from: C, options: JSONEncodingOptions
) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the messages.
static func with((inout Self) throws -> ()
) rethrows -> Self Creates an instance of the message type on which this method is called, executes the given block passing the message in as its sole
inout
argument, and then returns the message.static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func == (lhs: Self, rhs: Self
) -> Bool
Show obsolete interfaces (3)
Hide obsolete interfaces
init<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Data
value containing a serialized message in Protocol Buffer binary format.
Instance features
var debugDescription: String
A description generated by recursively visiting all fields in the message, including messages.
var isInitialized: Bool
Generated proto2 messages that contain required fields, nested messages that contain required fields, and/or extensions will provide their own implementation of this property that tests that all required fields are set. Users of the generated code SHOULD NOT override this property.
func hash(into: inout Hasher
) A hash based on the message’s full contents.
func isEqualTo(message: any Message
) -> Bool func jsonString(options: JSONEncodingOptions
) throws -> String Returns a string containing the JSON serialization of the message.
func jsonUTF8Bytes<Bytes>(options: JSONEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
containing the UTF-8 JSON serialization of the message.func jsonUTF8Data(options: JSONEncodingOptions
) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the message.
func merge(from: Self, fieldMask: Google_Protobuf_FieldMask, mergeOption: Google_Protobuf_FieldMask.MergeOptions
) throws Merges fields specified in a FieldMask into another message.
func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
SwiftProtobufContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.func merge(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Data
value containing a serialized message in Protocol Buffer binary format into the receiver.func serializedBytes<Bytes>(partial: Bool, options: BinaryEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
instance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool
) throws -> Data Returns a
Data
instance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool, options: BinaryEncodingOptions
) throws -> Data Returns a
Data
instance containing the Protocol Buffer binary format serialization of the message.func textFormatString(
) -> String Returns a string containing the Protocol Buffer text format serialization of the message.
func textFormatString(options: TextFormatEncodingOptions
) -> String Returns a string containing the Protocol Buffer text format serialization of the message.
func trim(keeping: Google_Protobuf_FieldMask
) -> Bool Removes from ‘message’ any field that is not represented in the given FieldMask. If the FieldMask is empty, does nothing.
Show implementation details (1)
Hide implementation details
Show obsolete interfaces (2)
Hide obsolete interfaces
func merge<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.