Struct Unit

A type with only one value.

Implements
Inherited Members
Namespace: Recore
Assembly: Recore.dll
Syntax
public struct Unit : IEquatable<Unit>
Remarks

Whereas Void is a type with no values, Unit is a type with one value. It is useful when designing generic types or methods so that a non-generic version does not have to be provided. It is also useful for fluent interfaces (such as LINQ) so that a chain of method calls does not have to be broken by a Void-returning call.

Examples

Imagine a type ApiResult<T> that wraps the deserialized JSON response from a REST API. Without Unit, you'd have to define a separate, non-generic ApiResult type for when the response doesn't have a body:

ApiResult postResult = await PostPersonAsync(person);
ApiResult<Person> getResult = await GetPersonAsync(id);

With Unit, you can just reuse the same type:

ApiResult<Unit> postResult = await PostPersonAsync(person);
ApiResult<Person> getResult = await GetPersonAsync(id);

In the definition of PostPersonAsync(), just return Unit.Value:

ApiResult<Unit> PostPersonAsync(Person person)
{
    // ...
    return new ApiResult<Unit>(Unit.Value);
}

Properties

| Improve this Doc View Source

Value

The singleton Unit value.

Declaration
public static Unit Value { get; }
Property Value
Type Description
Unit

Methods

| Improve this Doc View Source

Close(Action)

Converts a return type of Void to a return type of Unit.

Declaration
public static Func<Unit> Close(Action action)
Parameters
Type Name Description
Action action
Returns
Type Description
Func<Unit>
| Improve this Doc View Source

Equals(Unit)

Two unit instances are always equal.

Declaration
public bool Equals(Unit other)
Parameters
Type Name Description
Unit other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Determines whether another object is the unit value.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Returns the hash code of the unit value.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

ToString()

Returns a string representation of the unit value.

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

Operators

| Improve this Doc View Source

Equality(Unit, Unit)

Two unit instances are always equal.

Declaration
public static bool operator ==(Unit lhs, Unit rhs)
Parameters
Type Name Description
Unit lhs
Unit rhs
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(Unit, Unit)

Two unit instances are always equal.

Declaration
public static bool operator !=(Unit lhs, Unit rhs)
Parameters
Type Name Description
Unit lhs
Unit rhs
Returns
Type Description
Boolean

Implements

Extension Methods