Struct TypeNullability

Namespace

LfrlAnvil

Assembly

LfrlAnvil.Core.dll

Represents detailed information about Type nullability.

public readonly struct TypeNullability : IEquatable<TypeNullability>

Implements

IEquatable<TypeNullability>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToNullable<T>(T)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Properties

ActualType

Specifies the actual Type.

public Type ActualType { get; }

Property Value

Type

IsNullable

Specifies whether or not the ActualType is nullable.

public bool IsNullable { get; }

Property Value

bool

UnderlyingType

Specifies the underlying Type. Will not be equal to ActualType only for nullable value types.

public Type UnderlyingType { get; }

Property Value

Type

Methods

Create(Type, bool)

Creates a new TypeNullability instance.

[Pure]
public static TypeNullability Create(Type type, bool isNullable = false)

Parameters

type Type

Source type.

isNullable bool

Specifies whether or not the result should be nullable. Equal to false by default. Will be ignored for nullable value types.

Returns

TypeNullability

New TypeNullability instance.

Create<T>(bool)

Creates a new TypeNullability instance.

[Pure]
public static TypeNullability Create<T>(bool isNullable = false) where T : notnull

Parameters

isNullable bool

Specifies whether or not the result should be nullable. Equal to false by default.

Returns

TypeNullability

New TypeNullability instance.

Type Parameters

T

Underlying type.

Equals(TypeNullability)

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

[Pure]
public bool Equals(TypeNullability other)

Parameters

other TypeNullability

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.

GetCommonType(TypeNullability?, TypeNullability?)

Returns a common TypeNullability instance for two instances.

[Pure]
public static TypeNullability? GetCommonType(TypeNullability? left, TypeNullability? right)

Parameters

left TypeNullability?

First type nullability.

right TypeNullability?

Second type nullability.

Returns

TypeNullability?

null when left is null or right is null or UnderlyingType properties are not equal, otherwise left when it is nullable, otherwise right.

GetCommonTypeWith(TypeNullability?)

Returns a common TypeNullability instance for this instance and the provided other.

[Pure]
public TypeNullability? GetCommonTypeWith(TypeNullability? other)

Parameters

other TypeNullability?

Other type nullability.

Returns

TypeNullability?

null when other is null or UnderlyingType properties are not equal, otherwise this when it is nullable, otherwise other.

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.

MakeNullable()

Creates a new TypeNullability instance from this instance with IsNullable set to true.

[Pure]
public TypeNullability MakeNullable()

Returns

TypeNullability

New TypeNullability instance.

MakeRequired()

Creates a new TypeNullability instance from this instance with IsNullable set to false.

[Pure]
public TypeNullability MakeRequired()

Returns

TypeNullability

New TypeNullability instance.

ToString()

Returns a string representation of this TypeNullability instance.

[Pure]
public override string ToString()

Returns

string

String representation.

Operators

operator ==(TypeNullability, TypeNullability)

Checks if a is equal to b.

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

Parameters

a TypeNullability

First operand.

b TypeNullability

Second operand.

Returns

bool

true when operands are equal, otherwise false.

operator !=(TypeNullability, TypeNullability)

Checks if a is not equal to b.

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

Parameters

a TypeNullability

First operand.

b TypeNullability

Second operand.

Returns

bool

true when operands are not equal, otherwise false.