 | OptionalValueT Structure |
Value type that represents a potentially missing value. This is similar to
`System.Nullable<T>`, but does not restrict the contained value to be a value
type, so it can be used for storing values of any types. When obtained from
`DataFrame<R, C>` or `Series<K, T>`, the `Value` will never be `Double.NaN` or `null`
(but this is not, in general, checked when constructing the value).
The type is only used in C#-friendly API. F# operations generally use expose
standard F# `option<T>` type instead. However, there the `OptionalValue` module
contains helper functions for using this type from F# as well as `Missing` and
`Present` active patterns.
[category:Primitive types and values]
Namespace: Deedle
Assembly: Deedle (in Deedle.dll) Version: 1.2
SyntaxThe OptionalValueT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OptionalValueT |
Creates a new instance of `OptionalValue<T>` that contains
the specified `T` value .
|
Properties| Name | Description | |
|---|---|---|
 | HasValue |
Gets a value indicating whether the current `OptionalValue<T>` has a value
|
 | Missing |
Returns a new instance of `OptionalValue<T>` that does not contain a value.
|
| Value |
Returns the value stored in the current `OptionalValue<T>`.
Exceptions:
`InvalidOperationException` - Thrown when `HasValue` is `false`.
|
| ValueOrDefault |
Returns the value stored in the current `OptionalValue<T>` or
the default value of the type `T` when a value is not present.
|
Methods| Name | Description | |
|---|---|---|
| Equals |
Support structural equality
(Overrides ValueTypeEquals(Object).) |
| GetHashCode |
Support structural equality
(Overrides ValueTypeGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Prints the value or "<null>" when the value is present, but is `null`
or "<missing>" when the value is not present (`HasValue = false`).
(Overrides ValueTypeToString.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsNullableT |
Extension method that converts optional value containing a value type
to a C# friendly `Nullable<T>` or `T?` type.
(Defined by OptionalValueExtensions.) |
| OrDefaultT |
Extension method that returns value in the specified optional value
or the provided default value (the second argument).
(Defined by OptionalValueExtensions.) |
See Also