Struct Duration
Represents a fixed (and calendar-independent) length of time.
Since 1.0.x
Availability net45, netstandard1.3
Implements
IEquatable<Duration>
IComparable<Duration>
IComparable
IXmlSerializable
IFormattable
ISerializable
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Namespace: NodaTime
Assembly: NodaTime.dll
Syntax
[Serializable]
public struct Duration : IEquatable<Duration>, IComparable<Duration>, IComparable, IXmlSerializable, IFormattable, ISerializableRemarks
A duration is a length of time defined by an integral number of nanoseconds. Although durations are usually used with a positive number of nanoseconds, negative durations are valid, and may occur naturally when e.g. subtracting a later Instant from an earlier one.
A duration represents a fixed length of elapsed time along the time line that occupies the same amount of time regardless of when it is applied. In contrast, Period represents a period of time in calendrical terms (years, months, days, and so on) that may vary in elapsed time when applied.
In general, use Duration to represent durations applied to global types like Instant
and ZonedDateTime; use Period to represent a period applied to local types like
LocalDateTime.
The range of valid values of a Duration is greater than the span of time supported by Noda Time - so for
example, subtracting one Instant from another will always give a valid Duration. The range
is also greater than that of System.TimeSpan (System.Int64.MinValue ticks to System.Int64.MaxValue ticks).
See the user guide for more details of the exact range, but it is not expected that this will ever be exceeded in normal code.
Various operations accept or return a System.Double, in-keeping with durations often being natural lengths
of time which are imprecisely measured anyway. The implementation of these operations should never result in a not-a-number
or infinite value, nor do any operations accept not-a-number or infinite values. Additionally, operations involving
Double have initially been implemented fairly naïvely; it's possible that future releases will improve the accuracy
or performance (or both) of various operations.
Properties
BclCompatibleTicks
Gets the total number of ticks in the duration as a 64-bit integer, truncating towards zero where necessary.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public long BclCompatibleTicks { get; }Property Value
| Type | Description |
|---|---|
| Int64 | The total number of ticks in the duration. |
Remarks
Within the constraints specified below, this property is intended to be equivalent to System.TimeSpan.Ticks.
If the number of nanoseconds in a duration is not a whole number of ticks, it is truncated towards zero. For example, durations in the range [-99ns, 99ns] would all count as 0 ticks.
Although this method can overflow, it will only do so in very exceptional cases, with durations with a magnitude of more than 29000 Gregorian years or so.
Exceptions
| Type | Condition |
|---|---|
| System.OverflowException | The number of ticks cannot be represented a signed 64-bit integer. |
See Also
Days
Gets the whole number of standard (24 hour) days within this duration. This is truncated towards zero;
for example, "-1.75 days" and "1.75 days" would have results of -1 and 1 respectively.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int Days { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The whole number of days in the duration |
Epsilon
Gets a Duration value equal to 1 nanosecond; the smallest amount by which an instant can vary.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Epsilon { get; }Property Value
| Type | Description |
|---|---|
| Duration | A duration representing 1 nanosecond. |
Hours
The hour component of this duration, in the range [-23, 23], truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int Hours { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The hour component of the duration, within the day. |
MaxValue
Gets the maximum value supported by Duration.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration MaxValue { get; }Property Value
| Type | Description |
|---|---|
| Duration |
Milliseconds
Gets the subsecond component of this duration, expressed in milliseconds, in the range [-999, 999] and truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int Milliseconds { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The subsecond component of the duration, in milliseconds. |
Minutes
The minute component of this duration, in the range [-59, 59], truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int Minutes { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The minute component of the duration, within the hour. |
MinValue
Gets the minimum (largest negative) value supported by Duration.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration MinValue { get; }Property Value
| Type | Description |
|---|---|
| Duration |
NanosecondOfDay
Gets the number of nanoseconds within the day of this duration. For negative durations, this
will be negative (or zero).
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public long NanosecondOfDay { get; }Property Value
| Type | Description |
|---|---|
| Int64 | The number of nanoseconds within the day of this duration. |
Seconds
Gets the second component of this duration, in the range [-59, 59], truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int Seconds { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The second component of the duration, within the minute. |
SubsecondNanoseconds
Gets the subsecond component of this duration, expressed in nanoseconds, in the range [-999999999, 999999999].
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int SubsecondNanoseconds { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The subsecond component of the duration, in nanoseconds. |
SubsecondTicks
Gets the subsecond component of this duration, expressed in ticks, in the range [-9999999, 9999999] and truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public int SubsecondTicks { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The subsecond component of the duration, in ticks. |
TotalDays
Gets the total number of days in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalDays { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of days in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.TotalDays.
It represents the complete duration in days, rather than only the whole number of
days. For example, for a duration of 36 hours, this property would return 1.5.
TotalHours
Gets the total number of hours in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalHours { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of hours in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.TotalHours.
Unlike Hours, it represents the complete duration in hours rather than the
whole number of hours as part of the day. So for a duration
of 1 day, 2 hours and 30 minutes, the Hours property will return 2, but TotalHours
will return 26.5.
TotalMilliseconds
Gets the total number of milliseconds in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalMilliseconds { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of milliseconds in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.TotalMilliseconds.
Unlike Milliseconds, it represents the complete duration in seconds rather than
the whole number of seconds within the minute. So for a duration
of 10 minutes, 20 seconds and 250 milliseconds, the Seconds property will return 20, but TotalSeconds
will return 620.25.
TotalMinutes
Gets the total number of minutes in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalMinutes { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of minutes in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.TotalMinutes.
Unlike Minutes, it represents the complete duration in minutes rather than
the whole number of minutes within the hour. So for a duration
of 2 hours, 30 minutes and 45 seconds, the Minutes property will return 30, but TotalMinutes
will return 150.75.
TotalNanoseconds
Gets the total number of nanoseconds in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalNanoseconds { get; }Property Value
| Type | Description |
|---|---|
| Double | This duration as a number of nanoseconds, represented as a Double. |
Remarks
The result is always an integer, but may not be precise due to the limitations
of the
Double type. In other works, Duration.FromNanoseconds(duration.TotalNanoseconds)
is not guaranteed to round-trip. To guarantee precision and round-tripping,
use ToBigIntegerNanoseconds() and FromNanoseconds(BigInteger).
TotalSeconds
Gets the total number of seconds in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalSeconds { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of seconds in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.TotalSeconds.
Unlike Seconds, it represents the complete duration in seconds rather than
the whole number of seconds within the minute. So for a duration
of 10 minutes, 20 seconds and 250 milliseconds, the Seconds property will return 20, but TotalSeconds
will return 620.25.
TotalTicks
Gets the total number of ticks in this duration, as a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public double TotalTicks { get; }Property Value
| Type | Description |
|---|---|
| Double | The total number of ticks in this duration. |
Remarks
This property is the
Duration equivalent of System.TimeSpan.Ticks,
except represented as double-precision floating point number instead of a 64-bit integer. This
is because Duration has a precision of nanoseconds, and also because the range
of 64-bit integers doesn't cover the number of possible ticks in a Duration. (The
latter is only an issue in durations outside the range of System.TimeSpan - in other words,
with magnitudes of over 29,000 years.)
See Also
Zero
Gets a zero Duration of 0 nanoseconds.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Zero { get; }Property Value
| Type | Description |
|---|---|
| Duration | The zero Duration value. |
Methods
Add(Duration, Duration)
Adds one duration to another. Friendly alternative to
operator+().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Add(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the sum of the given values. |
CompareTo(Duration)
Compares the current object with another object of the same type.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public int CompareTo(Duration other)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | other | An object to compare with this object. |
Returns
| Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Int32 |
A 32-bit signed integer that indicates the relative order of the objects being compared.
The return value has the following meanings:
|
Divide(Duration, Duration)
Divides one duration by another. Friendly alternative to
operator/().
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static double Divide(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Double | The System.Double representing the result of dividing left by
right. |
Divide(Duration, Double)
Divides a duration by a System.Double. Friendly alternative to
operator/().
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Divide(Duration left, double right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Double | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of dividing left by
right. |
Divide(Duration, Int64)
Divides a duration by an System.Int64. Friendly alternative to
operator/().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Divide(Duration left, long right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Int64 | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of dividing left by
right. |
Equals(Duration)
Indicates whether the current object is equal to another object of the same type.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public bool Equals(Duration other)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| Boolean |
true if the current object is equal to the other parameter;
otherwise, false.
|
Equals(Object)
Determines whether the specified System.Object is equal to this instance.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The System.Object to compare with this instance. |
Returns
| Type | Description |
|---|---|
| Boolean |
true if the specified System.Object is equal to this instance;
otherwise, false.
|
Overrides
System.ValueType.Equals(System.Object)
FromDays(Double)
Returns a Duration that represents the given number of days, assuming a 'standard' 24-hour
day.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromDays(double days)Parameters
| Type | Name | Description |
|---|---|---|
| Double | days | The number of days. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of days. |
FromDays(Int32)
Returns a Duration that represents the given number of days, assuming a 'standard' 24-hour
day.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static Duration FromDays(int days)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | days | The number of days. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of days. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromDays(5);
Console.WriteLine(duration.Days);
Console.WriteLine(duration.ToString());
Output:
5
5:00:00:00
FromHours(Double)
Returns a Duration that represents the given number of hours.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromHours(double hours)Parameters
| Type | Name | Description |
|---|---|---|
| Double | hours | The number of hours. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of hours. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromHours(1.5);
Console.WriteLine(duration.Hours);
Console.WriteLine(duration.TotalHours);
Console.WriteLine(duration.TotalMinutes);
Console.WriteLine(duration.ToString());
Output:
1
1.5
90
0:01:30:00
FromHours(Int32)
Returns a Duration that represents the given number of hours.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static Duration FromHours(int hours)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | hours | The number of hours. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of hours. |
FromMilliseconds(Double)
Returns a Duration that represents the given number of milliseconds.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromMilliseconds(double milliseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Double | milliseconds | The number of milliseconds. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of milliseconds. |
FromMilliseconds(Int64)
Returns a Duration that represents the given number of milliseconds.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromMilliseconds(long milliseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | milliseconds | The number of milliseconds. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of milliseconds. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromMilliseconds(600);
Console.WriteLine(duration.Milliseconds);
Console.WriteLine(duration.TotalSeconds);
Console.WriteLine(duration.ToString());
Output:
600
0.6
0:00:00:00.6
FromMinutes(Double)
Returns a Duration that represents the given number of minutes.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromMinutes(double minutes)Parameters
| Type | Name | Description |
|---|---|---|
| Double | minutes | The number of minutes. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of minutes. |
FromMinutes(Int64)
Returns a Duration that represents the given number of minutes.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromMinutes(long minutes)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | minutes | The number of minutes. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of minutes. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromMinutes(50);
Console.WriteLine(duration.Minutes);
Console.WriteLine(duration.ToString());
Output:
50
0:00:50:00
FromNanoseconds(Double)
Converts a number of nanoseconds expressed as a System.Double into a duration. Any fractional
parts of the value are truncated towards zero.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromNanoseconds(double nanoseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Double | nanoseconds | The number of nanoseconds to represent. |
Returns
| Type | Description |
|---|---|
| Duration | A duration with the given number of nanoseconds. |
FromNanoseconds(Int64)
Returns a Duration that represents the given number of nanoseconds.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromNanoseconds(long nanoseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | nanoseconds | The number of nanoseconds. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of nanoseconds. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromNanoseconds(1_000_000_000);
Console.WriteLine(duration.TotalNanoseconds);
Console.WriteLine(duration.TotalSeconds);
Console.WriteLine(duration.ToString());
Output:
1000000000
1
0:00:00:01
FromNanoseconds(BigInteger)
Converts a number of nanoseconds expressed as a System.Numerics.BigInteger into a duration.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromNanoseconds(BigInteger nanoseconds)Parameters
| Type | Name | Description |
|---|---|---|
| BigInteger | nanoseconds | The number of nanoseconds to represent. |
Returns
| Type | Description |
|---|---|
| Duration | A duration with the given number of nanoseconds. |
FromSeconds(Double)
Returns a Duration that represents the given number of seconds.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromSeconds(double seconds)Parameters
| Type | Name | Description |
|---|---|---|
| Double | seconds | The number of seconds. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of seconds. |
FromSeconds(Int64)
Returns a Duration that represents the given number of seconds.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromSeconds(long seconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | seconds | The number of seconds. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of seconds. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromSeconds(42);
Console.WriteLine(duration.Seconds);
Console.WriteLine(duration.ToString());
Output:
42
0:00:00:42
FromTicks(Double)
Returns a Duration that represents the given number of ticks.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromTicks(double ticks)Parameters
| Type | Name | Description |
|---|---|---|
| Double | ticks | The number of ticks. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of ticks. |
FromTicks(Int64)
Returns a Duration that represents the given number of ticks.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromTicks(long ticks)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | ticks | The number of ticks. |
Returns
| Type | Description |
|---|---|
| Duration | A Duration representing the given number of ticks. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromTicks(10_000_000);
Console.WriteLine(duration.TotalTicks);
Console.WriteLine(duration.TotalSeconds);
Console.WriteLine(duration.ToString());
Output:
10000000
1
0:00:00:01
FromTimeSpan(TimeSpan)
Returns a Duration that represents the same number of ticks as the
given System.TimeSpan.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration FromTimeSpan(TimeSpan timeSpan)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | timeSpan | The TimeSpan value to convert |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration with the same number of ticks as the given TimeSpan. |
Sample snippet
using NodaTime;
using System;
Duration duration = Duration.FromTimeSpan(TimeSpan.FromHours(3));
Console.WriteLine(duration.Hours);
Console.WriteLine(duration.ToString());
Output:
3
0:03:00:00
GetHashCode()
Returns a hash code for this instance.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
Overrides
System.ValueType.GetHashCode()
Max(Duration, Duration)
Returns the larger duration of the given two.
Since 2.3.x
Availability net45, netstandard1.3
Declaration
public static Duration Max(Duration x, Duration y)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | x | The first duration to compare. |
| Duration | y | The second duration to compare. |
Returns
| Type | Description |
|---|---|
| Duration | The larger duration of x or y. |
Remarks
A "larger" duration is one that advances time by more than a "smaller" one. This means
that a positive duration is always larger than a negative one, for example. (This is the same
comparison used by the binary comparison operators.)
Min(Duration, Duration)
Returns the smaller duration of the given two.
Since 2.3.x
Availability net45, netstandard1.3
Declaration
public static Duration Min(Duration x, Duration y)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | x | The first duration to compare. |
| Duration | y | The second duration to compare. |
Returns
| Type | Description |
|---|---|
| Duration | The smaller duration of x or y. |
Remarks
A "larger" duration is one that advances time by more than a "smaller" one. This means
that a positive duration is always larger than a negative one, for example. (This is the same
comparison used by the binary comparison operators.)
Minus(Duration)
Returns the result of subtracting another duration from this one, for a fluent alternative to
operator-().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public Duration Minus(Duration other)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | other | The duration to subtract |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of the subtraction. |
Multiply(Duration, Double)
Multiplies a duration by a number. Friendly alternative to
operator*().
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Multiply(Duration left, double right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Double | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the product of the given values. |
Multiply(Duration, Int64)
Multiplies a duration by a number. Friendly alternative to
operator*().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Multiply(Duration left, long right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Int64 | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the product of the given values. |
Multiply(Int64, Duration)
Multiplies a duration by a number. Friendly alternative to
operator*().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Multiply(long left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the product of the given values. |
Negate(Duration)
Implements a friendly alternative to the unary negation operator.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Negate(Duration duration)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | duration | Duration to negate |
Returns
| Type | Description |
|---|---|
| Duration | The negative value of this duration |
Plus(Duration)
Returns the result of adding another duration to this one, for a fluent alternative to
operator+().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public Duration Plus(Duration other)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | other | The duration to add |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of the addition. |
Subtract(Duration, Duration)
Subtracts one duration from another. Friendly alternative to
operator-().
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration Subtract(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the difference of the given values. |
ToBigIntegerNanoseconds()
Conversion to a System.Numerics.BigInteger number of nanoseconds, as a convenient built-in numeric
type which can always represent values in the range we need.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public BigInteger ToBigIntegerNanoseconds()Returns
| Type | Description |
|---|---|
| BigInteger | This duration as a number of nanoseconds, represented as a BigInteger. |
ToInt64Nanoseconds()
Conversion to an System.Int64 number of nanoseconds. This will fail if the number of nanoseconds is
out of the range of
Int64, which is approximately 292 years (positive or negative).
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public long ToInt64Nanoseconds()Returns
| Type | Description |
|---|---|
| Int64 | This duration as a number of nanoseconds, represented as an Int64. |
Exceptions
| Type | Condition |
|---|---|
| System.OverflowException | The number of nanoseconds is outside the representable range. |
ToString()
Returns a System.String that represents this instance.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | The value of the current instance in the default format pattern ("o"), using the current thread's culture to obtain a format provider. |
Overrides
System.ValueType.ToString()
ToString(String, IFormatProvider)
Formats the value of the current instance using the specified pattern.
Since 1.2.x
Availability net45, netstandard1.3
Declaration
public string ToString(string patternText, IFormatProvider formatProvider)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | The System.String specifying the pattern to use, or null to use the default format pattern ("o"). |
| IFormatProvider | formatProvider | The System.IFormatProvider to use when formatting the value, or null to use the current thread's culture to obtain a format provider. |
Returns
| Type | Description |
|---|---|
| String | A System.String containing the value of the current instance in the specified format. |
ToTimeSpan()
Returns a System.TimeSpan that represents the same number of ticks as this
Duration.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public TimeSpan ToTimeSpan()Returns
| Type | Description |
|---|---|
| TimeSpan | A new TimeSpan with the same number of ticks as this Duration. |
Remarks
If the number of nanoseconds in a duration is not a whole number of ticks, it is truncated towards zero.
For example, durations in the range [-99ns, 99ns] would all count as 0 ticks.
Exceptions
| Type | Condition |
|---|---|
| System.OverflowException | The number of ticks cannot be represented a signed 64-bit integer. |
Operators
Addition(Duration, Duration)
Implements the operator + (addition).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator +(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the sum of the given values. |
Division(Duration, Duration)
Implements the operator / (division) to divide one duration by another.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static double operator /(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Double | The System.Double representing the result of dividing left by
right. |
Division(Duration, Double)
Implements the operator / (division) to divide a duration by a System.Double.
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator /(Duration left, double right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Double | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of dividing left by
right. |
Division(Duration, Int64)
Implements the operator / (division) to divide a duration by an System.Int64.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator /(Duration left, long right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Int64 | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of dividing left by
right. |
Equality(Duration, Duration)
Implements the operator == (equality).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator ==(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if values are equal to each other, otherwise false. |
GreaterThan(Duration, Duration)
Implements the operator > (greater than).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator>(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the left value is greater than the right value, otherwise false. |
GreaterThanOrEqual(Duration, Duration)
Implements the operator >= (greater than or equal).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator >=(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the left value is greater than or equal to the right value, otherwise false. |
Inequality(Duration, Duration)
Implements the operator != (inequality).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator !=(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if values are not equal to each other, otherwise false. |
LessThan(Duration, Duration)
Implements the operator < (less than).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator <(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the left value is less than the right value, otherwise false. |
LessThanOrEqual(Duration, Duration)
Implements the operator <= (less than or equal).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static bool operator <=(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the left value is less than or equal to the right value, otherwise false. |
Multiply(Duration, Double)
Implements the operator * (multiplication).
Since 2.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator *(Duration left, double right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Double | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of multiplying left by
right. |
Multiply(Duration, Int64)
Implements the operator * (multiplication).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator *(Duration left, long right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Int64 | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of multiplying left by
right. |
Multiply(Int64, Duration)
Implements the operator * (multiplication).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator *(long left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the result of multiplying left by
right. |
Subtraction(Duration, Duration)
Implements the operator - (subtraction).
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator -(Duration left, Duration right)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | left | The left hand side of the operator. |
| Duration | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Duration | A new Duration representing the difference of the given values. |
UnaryNegation(Duration)
Implements the unary negation operator.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
public static Duration operator -(Duration duration)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | duration | Duration to negate |
Returns
| Type | Description |
|---|---|
| Duration | The negative value of this duration |
Explicit Interface Implementations
IComparable.CompareTo(Object)
Implementation of System.IComparable.CompareTo(System.Object) to compare two offsets.
Since 1.0.x
Availability net45, netstandard1.3
Declaration
int IComparable.CompareTo(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object to compare this value with. |
Returns
| Type | Description |
|---|---|
| Int32 | The result of comparing this instant with another one; see CompareTo(Duration) for general details.
If obj is null, this method returns a value greater than 0.
|
Remarks
This uses explicit interface implementation to avoid it being called accidentally. The generic implementation should usually be preferred.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | obj is non-null but does not refer to an instance of Duration. |
ISerializable.GetObjectData(SerializationInfo, StreamingContext)
Implementation of System.Runtime.Serialization.ISerializable.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext).
Since 1.2.x
Availability net45
Declaration
[SecurityCritical]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| SerializationInfo | info | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| StreamingContext | context | The destination for this serialization. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | info is null. |
IXmlSerializable.GetSchema()
Since 1.2.x
Availability net45, netstandard1.3
Declaration
XmlSchema IXmlSerializable.GetSchema()Returns
| Type | Description |
|---|---|
| XmlSchema |
IXmlSerializable.ReadXml(XmlReader)
Since 1.2.x
Availability net45, netstandard1.3
Declaration
void IXmlSerializable.ReadXml(XmlReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| XmlReader | reader |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | reader is null. |
IXmlSerializable.WriteXml(XmlWriter)
Since 1.2.x
Availability net45, netstandard1.3
Declaration
void IXmlSerializable.WriteXml(XmlWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| XmlWriter | writer |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | writer is null. |
Implements
System.IEquatable<T>
System.IComparable<T>
System.IComparable
System.Xml.Serialization.IXmlSerializable
System.IFormattable
System.Runtime.Serialization.ISerializable