Struct Duration

Represents a duration. A duration stores separately months, days, and seconds due to the fact that the number of days in a month varies, and a day can have 23 or 25 hours if a daylight saving is involved.

Implements
Inherited Members
Namespace: Cassandra
Assembly: Cassandra.dll
Syntax
public struct Duration : IEquatable<Duration>, IComparable<Duration>
Remarks

Duration instances are immutable and thread-safe.

Constructors

Duration(int, int, long)

Creates a new instance of Duration.

Declaration
public Duration(int months, int days, long nanoseconds)
Parameters
Type Name Description
int months

The number of months.
int days

The number of days.
long nanoseconds

The number of nanoseconds.

Fields

Zero

Declaration
public static readonly Duration Zero
Field Value
Type Description
Duration

Properties

Days

Gets the number of days.

Declaration
public int Days { get; }
Property Value
Type Description
int

Months

Gets the number of months.

Declaration
public int Months { get; }
Property Value
Type Description
int

Nanoseconds

Gets the number of nanoseconds.

Declaration
public long Nanoseconds { get; }
Property Value
Type Description
long

Methods

CompareTo(Duration)

Compares this instance against another Duration instance based on the bytes representation of the values.

Declaration
public int CompareTo(Duration other)
Parameters
Type Name Description
Duration other
Returns
Type Description
int

Equals(Duration)

Returns true if the value of the Duration is the same.

Declaration
public bool Equals(Duration other)
Parameters
Type Name Description
Duration other
Returns
Type Description
bool

Equals(object)

Returns true if the value of the Duration is the same.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

FromTimeSpan(TimeSpan)

Creates a new Duration instance based on the TimeSpan provided.

Consider that 24 hour days (no leap seconds) are used to calculate the days portion.

Declaration
public static Duration FromTimeSpan(TimeSpan timespan)
Parameters
Type Name Description
TimeSpan timespan
Returns
Type Description
Duration

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Parse(string)

Creates a new Duration instance from the string representation of the value.

Accepted formats:

  • multiple digits followed by a time unit like: 12h30m where the time unit can be:
    • y: years
    • m: months
    • w: weeks
    • d: days
    • h: hours
    • m: minutes
    • s: seconds
    • ms: milliseconds
    • us or µs: microseconds
    • ns: nanoseconds
  • ISO 8601 format: 
    P[n]Y[n]M[n]DT[n]H[n]M[n]S or P[n]W
  • ISO 8601 alternative format: 
    P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
Declaration
public static Duration Parse(string input)
Parameters
Type Name Description
string input
Returns
Type Description
Duration

ToIsoString()

A string representation of this duration using ISO-8601 based representation, such as PT8H6M12.345S.

Declaration
public string ToIsoString()
Returns
Type Description
string

ToString()

Returns the string representation of the value.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

ToTimeSpan()

Returns a TimeSpan instance that represents the same interval than this instance.

You should take into consideration that TimeSpan is internally represented in ticks, so for the conversion, 24h days will be used (leap seconds are not considered). For Duration values with month portion, it will throw an InvalidOperationException.

Declaration
public TimeSpan ToTimeSpan()
Returns
Type Description
TimeSpan
Exceptions
Type Condition
InvalidOperationException

values including month portion.

Operators

operator ==(Duration, Duration)

Compares value equality of 2 DateRange instances.

Declaration
public static bool operator ==(Duration a, Duration b)
Parameters
Type Name Description
Duration a
Duration b
Returns
Type Description
bool

explicit operator Duration(TimeSpan)

Declaration
public static explicit operator Duration(TimeSpan ts)
Parameters
Type Name Description
TimeSpan ts
Returns
Type Description
Duration

operator !=(Duration, Duration)

Compares value inequality of 2 DateRange instances.

Declaration
public static bool operator !=(Duration a, Duration b)
Parameters
Type Name Description
Duration a
Duration b
Returns
Type Description
bool

Implements