1 #region Copyright notice and license
2 // Protocol Buffers - Google's data interchange format
3 // Copyright 2015 Google Inc.  All rights reserved.
4 // https://developers.google.com/protocol-buffers/
5 //
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are
8 // met:
9 //
10 //     * Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 //     * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following disclaimer
14 // in the documentation and/or other materials provided with the
15 // distribution.
16 //     * Neither the name of Google Inc. nor the names of its
17 // contributors may be used to endorse or promote products derived from
18 // this software without specific prior written permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #endregion
32 
33 using System;
34 using System.Collections.Generic;
35 using System.Linq;
36 using System.Text;
37 using System.Threading.Tasks;
38 
39 namespace Google.Protobuf.WellKnownTypes
40 {
41     /// <summary>
42     /// Extension methods on BCL time-related types, converting to protobuf types.
43     /// </summary>
44     public static class TimeExtensions
45     {
46         /// <summary>
47         /// Converts the given <see cref="DateTime"/> to a <see cref="Timestamp"/>.
48         /// </summary>
49         /// <param name="dateTime">The date and time to convert to a timestamp.</param>
50         /// <exception cref="ArgumentException">The <paramref name="dateTime"/> value has a <see cref="DateTime.Kind"/>other than <c>Utc</c>.</exception>
51         /// <returns>The converted timestamp.</returns>
ToTimestamp(this DateTime dateTime)52         public static Timestamp ToTimestamp(this DateTime dateTime)
53         {
54             return Timestamp.FromDateTime(dateTime);
55         }
56 
57         /// <summary>
58         /// Converts the given <see cref="DateTimeOffset"/> to a <see cref="Timestamp"/>
59         /// </summary>
60         /// <remarks>The offset is taken into consideration when converting the value (so the same instant in time
61         /// is represented) but is not a separate part of the resulting value. In other words, there is no
62         /// roundtrip operation to retrieve the original <c>DateTimeOffset</c>.</remarks>
63         /// <param name="dateTimeOffset">The date and time (with UTC offset) to convert to a timestamp.</param>
64         /// <returns>The converted timestamp.</returns>
ToTimestamp(this DateTimeOffset dateTimeOffset)65         public static Timestamp ToTimestamp(this DateTimeOffset dateTimeOffset)
66         {
67             return Timestamp.FromDateTimeOffset(dateTimeOffset);
68         }
69 
70         /// <summary>
71         /// Converts the given <see cref="TimeSpan"/> to a <see cref="Duration"/>.
72         /// </summary>
73         /// <param name="timeSpan">The time span to convert.</param>
74         /// <returns>The converted duration.</returns>
ToDuration(this TimeSpan timeSpan)75         public static Duration ToDuration(this TimeSpan timeSpan)
76         {
77             return Duration.FromTimeSpan(timeSpan);
78         }
79     }
80 }
81