Struct Nil

Namespace

LfrlAnvil.Functional

Assembly

LfrlAnvil.Functional.dll

Represents a lack of value.

public readonly struct Nil : IEquatable<Nil>, IComparable<Nil>, IComparable

Implements

IEquatable<Nil>

IComparable<Nil>

IComparable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectExtensions.Mutate<T>(T, T)

ObjectExtensions.ToEither<T>(T)

ObjectExtensions.ToErratic<T>(T)

ObjectExtensions.ToMaybe<T>(T?)

ObjectExtensions.ToMutation<T>(T)

ObjectExtensions.TypeCast<T>(T)

Fields

Instance

Nil singleton instance.

public static readonly Nil Instance

Field Value

Nil

Methods

CompareTo(Nil)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

[Pure]
public int CompareTo(Nil other)

Parameters

other Nil

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

CompareTo(object?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

[Pure]
public int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

Equals(Nil)

Indicates whether the current object is equal to another object of the same type.

[Pure]
public bool Equals(Nil other)

Parameters

other Nil

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

[Pure]
public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

[Pure]
public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns a string representation of this Nil instance.

[Pure]
public override string ToString()

Returns

string

String representation.

Operators

operator ==(Nil, Nil)

Checks if a is equal to b.

[Pure]
public static bool operator ==(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

true.

operator >(Nil, Nil)

Checks if a is greater than b.

[Pure]
public static bool operator >(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

false.

operator >=(Nil, Nil)

Checks if a is greater than or equal to b.

[Pure]
public static bool operator >=(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

true.

operator !=(Nil, Nil)

Checks if a is not equal to b.

[Pure]
public static bool operator !=(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

false.

operator <(Nil, Nil)

Checks if a is less than b.

[Pure]
public static bool operator <(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

false.

operator <=(Nil, Nil)

Checks if a is less than or equal to b.

[Pure]
public static bool operator <=(Nil a, Nil b)

Parameters

a Nil

First operand.

b Nil

Second operand.

Returns

bool

true.