Class TimeSpanExtensions

This class contains extension methods used to simplify working with TimeSpans. Note! Part of internal API. Breaking changes may occur without notice. Use at own risk.

Inheritance

Object

TimeSpanExtensions

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.TestKit.Internal

Assembly: Akka.TestKit.dll

Syntax

public static class TimeSpanExtensions

Methods

| Improve this Doc View Source

EnsureIsPositiveFinite(TimeSpan, String)

Throws an ArgumentException if the timeSpan is not 0 or greater. Note! Part of internal API. Breaking changes may occur without notice. Use at own risk.

Declaration

public static void EnsureIsPositiveFinite(this TimeSpan timeSpan, string parameterName)

Parameters

Type	Name	Description
TimeSpan	timeSpan	The timespan used for comparison.
String	parameterName	The name of the timespan.

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the given timespan has zero or less ticks.

| Improve this Doc View Source

IsInfinite(Nullable<TimeSpan>)

Determine if the supplied timeSpan has a negative number of ticks.

note

This is a relaxed definition of a TimeSpan. For a stricter definition, use IsInfiniteTimeout(TimeSpan)

Declaration

public static bool IsInfinite(this TimeSpan? timeSpan)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has a negative number of ticks; otherwise, `false`.

| Improve this Doc View Source

IsInfinite(TimeSpan)

Determine if the supplied timeSpan has a negative number of ticks.

note

This is a relaxed definition of a TimeSpan. For a stricter definition, use IsInfiniteTimeout(TimeSpan)

Declaration

public static bool IsInfinite(this TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has a negative number of ticks; otherwise, `false`.

| Improve this Doc View Source

IsInfiniteTimeout(Nullable<TimeSpan>)

Determine if the supplied timeSpan is equal to InfiniteTimeSpan.

Declaration

public static bool IsInfiniteTimeout(this TimeSpan? timeSpan)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeSpan	The timespan used for comparison.

Returns

Type	Description
Boolean	`true` if the given timespan is equal to InfiniteTimeSpan; otherwise, `false`.

| Improve this Doc View Source

IsInfiniteTimeout(TimeSpan)

Determine if the supplied timeSpan is equal to InfiniteTimeSpan.

Declaration

public static bool IsInfiniteTimeout(this TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan	The timespan used for comparison.

Returns

Type	Description
Boolean	`true` if the given timespan is equal to InfiniteTimeSpan; otherwise, `false`.

| Improve this Doc View Source

IsPositiveFinite(Nullable<TimeSpan>)

Determine if the supplied timeSpan has one or more ticks.

Declaration

public static bool IsPositiveFinite(this TimeSpan? timeSpan)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has one or more ticks; otherwise, `false`.

| Improve this Doc View Source

IsPositiveFinite(TimeSpan)

Determine if the supplied timeSpan has one or more ticks.

Declaration

public static bool IsPositiveFinite(this TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has one or more ticks; otherwise, `false`.

| Improve this Doc View Source

IsUndefined(Nullable<TimeSpan>)

Determine if the supplied timeSpan has no value.

Declaration

public static bool IsUndefined(this TimeSpan? timeSpan)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeSpan	The timespan used to check for a value

Returns

Type	Description
Boolean	`true` if the given timespan has no value; otherwise, `false`.

| Improve this Doc View Source

IsZero(Nullable<TimeSpan>)

Determine if the supplied timeSpan has zero ticks.

Declaration

public static bool IsZero(this TimeSpan? timeSpan)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has zero ticks; otherwise, `false`.

| Improve this Doc View Source

IsZero(TimeSpan)

Determine if the supplied timeSpan has zero ticks.

Declaration

public static bool IsZero(this TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan	The timespan used to check the number of ticks.

Returns

Type	Description
Boolean	`true` if the given timespan has zero ticks; otherwise, `false`.

| Improve this Doc View Source

Min(TimeSpan, Nullable<TimeSpan>)

Compares two supplied timespans and returns the timespan with the least amount of positive ticks.

If b is null it's treated as undefined, and a is returned.

Declaration

public static TimeSpan Min(this TimeSpan a, TimeSpan? b)

Parameters

Type	Name	Description
TimeSpan	a	The first timespan used for comparison.
Nullable<TimeSpan>	b	The second timespan used for comparison

Returns

Type	Description
TimeSpan	The timespan with the least amount of ticks between the two given timespans.