-
Notifications
You must be signed in to change notification settings - Fork 535
/
duration.rb
91 lines (89 loc) · 3.68 KB
/
duration.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Google
module Protobuf
# 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 (durations.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".
# @!attribute [rw] seconds
# @return [Integer]
# 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
# @!attribute [rw] nanos
# @return [Integer]
# 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.
class Duration; end
end
end