An OVRResult<TValue,TStatus> represents the result of an operation which may fail. If the operation succeeds (Success is True), then you can access the value using the Value property.

If it fails (Success is False), then the OVRResult does not have a value, and it is an error to access the Value property. In this case, the Status property will contain an error code.

Properties

bool Success[Get]

Gets a bool indicating whether the result is a success.

TStatus Status[Get]

Gets the status of the result.

bool HasValue[Get]

Gets a bool indicating whether the result has a value.

TValue Value[Get]

The value of the result.

It is an error to access this property unless Success is True. See also TryGetValue.

Exceptions

InvalidOperationException

Thrown if Success is False.

See Also

TryGetValue, HasValue

Static Member Functions

static OVRResult< TStatus > From< TStatus >

( TStatus status )

static OVRResult< TResult, TStatus > From< TResult, TStatus >

( TResult result,

TStatus status )

static OVRResult< TStatus > From

( TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified status.

Parameters

status

The status.

Returns

A new OVRResult<TValue, TStatus> with the specified status.

See Also

FromSuccess, FromFailure

static OVRResult< TStatus > FromSuccess

( TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified success status.

Parameters

status

The status (must be a valid success status).

Returns

A new OVRResult<TValue, TStatus> with the specified status.

Exceptions

ArgumentException

Thrown when status is not a valid success status.

See Also

From, FromFailure

static OVRResult< TStatus > FromFailure

( TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified failure status.

Parameters

status

The status (must be a valid failure status).

Returns

A new OVRResult<TValue, TStatus> with the specified status.

Exceptions

ArgumentException

Thrown when status is not a valid failure status.

See Also

From, FromSuccess

static OVRResult< TValue, TStatus > From

( TValue value,

TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified value and status.

Parameters

value

The value.

status

The status.

Returns

A new OVRResult<TValue, TStatus> with the specified value and status.

See Also

FromSuccess, FromFailure

static OVRResult< TValue, TStatus > FromSuccess

( TValue value,

TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified value and a success status.

Parameters

value

The value.

status

The status (must be a valid success status).

Returns

A new OVRResult<TValue, TStatus> with the specified value and status.

Exceptions

ArgumentException

Thrown when status is not a valid success status.

See Also

From, FromFailure

static OVRResult< TValue, TStatus > FromFailure

( TStatus status )

Creates a new OVRResult<TValue, TStatus> with the specified failure status.

Parameters

status

The status (must be a valid failure status).

Returns

A new OVRResult<TValue, TStatus> with the specified status.

Exceptions

ArgumentException

Thrown when status is not a valid failure status.

See Also

From, FromSuccess

Member Functions

bool Equals

( OVRResult< TStatus > other )

Determines whether the current OVRResult<TStatus> is equal to another OVRResult<TStatus>.

Parameters

other

The OVRResult<TStatus> to compare with the current one.

Returns

true if the specified OVRResult<TStatus> is equal to the current OVRResult<TStatus>; otherwise, false.

override bool Equals

( object obj )

Determines whether the current OVRResult<TStatus> is equal to another object.

Parameters

obj

The object to compare with the current OVRResult<TStatus>.

Returns

true if the specified object is equal to the current OVRResult<TStatus>; otherwise, false.

override int GetHashCode ( )

Gets a hashcode suitable for use in a Dictionary or HashSet.

Returns

A hashcode for this result.

override string ToString ( )

Generates a string representation of this result object.

The string representation is the stringification of Status, or "(invalid result)" if this result object has not been initialized.

Returns

A string representation of this OVRResult<TStatus>

bool TryGetValue

( out TValue value )

Tries to retrieve the value of the result.

Parameters

value

When this method returns, contains the value of the result if the result was successful; otherwise, the default value.

Returns

true if the result was successful and the value is retrieved; otherwise, false.

See Also

Value, HasValue

bool Equals

( OVRResult< TValue, TStatus > other )

Determines whether the current OVRResult<TValue, TStatus> is equal to another OVRResult<TValue, TStatus>.

Parameters

other

The OVRResult<TValue, TStatus> to compare with the current one.

Returns

true if the specified OVRResult<TValue, TStatus> is equal to the current OVRResult<TValue, TStatus>; otherwise, false.

override bool Equals

( object obj )

Determines whether the current OVRResult<TValue, TStatus> is equal to another object.

Parameters

obj

The object to compare with the current OVRResult<TValue, TStatus>.

Returns

true if the specified object is equal to the current OVRResult<TValue, TStatus>; otherwise, false.

override bool TStatus other && Equals

( other )

override int GetHashCode ( )

Gets a hashcode suitable for use in a Dictionary or HashSet.

Returns

A hashcode for this result.

override string ToString ( )

Generates a string representation of this result object.

If this result object has not been initialized, the string is "(invalid result)". Otherwise, if Success is True, then the string is the stringification of the Status and Value. If Success is False, then it is just the stringification of Status.

Returns

A string representation of this OVRResult<TStatus>

Did you find this page helpful?