FSharpx.Extras


Nullable Module

Functions and values

Function or value Description

a *? b

Full Usage: a *? b

Parameters:
Returns: Nullable<^c>
Modifiers: inline
a : Nullable<^a>
b : Nullable<^b>
Returns: Nullable<^c>

a &? b

Full Usage: a &? b

Parameters:
Returns: Nullable<bool>
Modifiers: inline
a : Nullable<bool>
b : Nullable<bool>
Returns: Nullable<bool>

a +? b

Full Usage: a +? b

Parameters:
Returns: Nullable<^c>
Modifiers: inline
a : Nullable<^a>
b : Nullable<^b>
Returns: Nullable<^c>

a -? b

Full Usage: a -? b

Parameters:
Returns: Nullable<^c>
Modifiers: inline
a : Nullable<^a>
b : Nullable<^b>
Returns: Nullable<^c>

a /? b

Full Usage: a /? b

Parameters:
Returns: Nullable<^c>
Modifiers: inline
a : Nullable<^a>
b : Nullable<^b>
Returns: Nullable<^c>

a <=? b

Full Usage: a <=? b

Parameters:
Returns: bool
Modifiers: inline
a : Nullable<'a>
b : Nullable<'a>
Returns: bool

a <? b

Full Usage: a <? b

Parameters:
Returns: bool
Modifiers: inline
a : Nullable<'a>
b : Nullable<'a>
Returns: bool

a >=? b

Full Usage: a >=? b

Parameters:
Returns: bool
Modifiers: inline
a : Nullable<'a>
b : Nullable<'a>
Returns: bool

a >? b

Full Usage: a >? b

Parameters:
Returns: bool
Modifiers: inline
a : Nullable<'a>
b : Nullable<'a>
Returns: bool

a |? b

Full Usage: a |? b

Parameters:
Returns: Nullable<bool>
Modifiers: inline
a : Nullable<bool>
b : Nullable<bool>
Returns: Nullable<bool>

bind f x

Full Usage: bind f x

Parameters:
Returns: Nullable<'b>

Monadic bind

f : 'a -> Nullable<'b>
x : Nullable<'a>
Returns: Nullable<'b>

count x

Full Usage: count x

Parameters:
Returns: int

Returns 1 if Nullable has value, otherwise 0

x : Nullable<'a>
Returns: int

create x

Full Usage: create x

Parameters:
    x : 'a

Returns: Nullable<'a>
x : 'a
Returns: Nullable<'a>

exists p x

Full Usage: exists p x

Parameters:
Returns: bool

Evaluates the equivalent of List.exists for a nullable.

p : Nullable<'a> -> bool
x : Nullable<'a>
Returns: bool

fold f state x

Full Usage: fold f state x

Parameters:
    f : 'a -> 'b -> 'a
    state : 'a
    x : Nullable<'b>

Returns: 'a

Evaluates the equivalent of List.fold for a nullable.

f : 'a -> 'b -> 'a
state : 'a
x : Nullable<'b>
Returns: 'a

foldBack f x state

Full Usage: foldBack f x state

Parameters:
Returns: 'b

Performs the equivalent of the List.foldBack operation on a nullable.

f : Nullable<'a> -> 'b -> 'b
x : Nullable<'a>
state : 'b
Returns: 'b

forall p x

Full Usage: forall p x

Parameters:
Returns: bool

Evaluates the equivalent of List.forall for a nullable.

p : Nullable<'a> -> bool
x : Nullable<'a>
Returns: bool

get x

Full Usage: get x

Parameters:
Returns: 'a

Gets the value associated with the Nullable. If no value, throws.

x : Nullable<'a>
Returns: 'a

getOrDefault n v

Full Usage: getOrDefault n v

Parameters:
Returns: 'a

Gets the value associated with the nullable or the supplied default value.

n : Nullable<'a>
v : 'a
Returns: 'a

getOrElse n v

Full Usage: getOrElse n v

Parameters:
Returns: 'T

Gets the value associated with the nullable or the supplied default value.

n : Nullable<'T>
v : Lazy<'T>
Returns: 'T

hasValue x

Full Usage: hasValue x

Parameters:
Returns: bool

True if Nullable has value

x : Nullable<'a>
Returns: bool

isNull x

Full Usage: isNull x

Parameters:
Returns: bool

True if Nullable does not have value

x : Nullable<'a>
Returns: bool

iter f x

Full Usage: iter f x

Parameters:

Executes a function for a nullable value.

f : 'a -> unit
x : Nullable<'a>

lift2 f a b

Full Usage: lift2 f a b

Parameters:
Returns: Nullable<'c>

Promote a function to a monad/applicative, scanning the monadic/applicative arguments from left to right.

f : 'a -> 'b -> 'c
a : Nullable<'a>
b : Nullable<'b>
Returns: Nullable<'c>

map f x

Full Usage: map f x

Parameters:
Returns: Nullable<'b>

Transforms a Nullable value by using a specified mapping function.

f : 'a -> 'b
x : Nullable<'a>
Returns: Nullable<'b>

mapBool op a b

Full Usage: mapBool op a b

Parameters:
Returns: bool
op : 'a -> 'b -> bool
a : Nullable<'a>
b : Nullable<'b>
Returns: bool

notn a

Full Usage: notn a

Parameters:
Returns: Nullable<bool>
Modifiers: inline
a : Nullable<bool>
Returns: Nullable<bool>

ofOption

Full Usage: ofOption

Returns: 'a option -> Nullable<'a>

Converts option to nullable

Returns: 'a option -> Nullable<'a>

toArray x

Full Usage: toArray x

Parameters:
Returns: 'a[]

Convert the nullable to an array of length 0 or 1.

x : Nullable<'a>
Returns: 'a[]

toList x

Full Usage: toList x

Parameters:
Returns: 'a list

Convert the nullable to a list of length 0 or 1.

x : Nullable<'a>
Returns: 'a list

toOption

Full Usage: toOption

Returns: Nullable<'a> -> 'a option

Converts nullable to option

Returns: Nullable<'a> -> 'a option

Type extensions

Type extension Description

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Int32>

Extended Type: Int32

() : unit
Returns: Nullable<Int32>

this.n

Full Usage: this.n

Returns: Nullable<Int32>

Extended Type: Int32

Returns: Nullable<Int32>

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Double>

Extended Type: Double

() : unit
Returns: Nullable<Double>

this.n

Full Usage: this.n

Returns: Nullable<Double>

Extended Type: Double

Returns: Nullable<Double>

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Single>

Extended Type: Single

() : unit
Returns: Nullable<Single>

this.n

Full Usage: this.n

Returns: Nullable<Single>

Extended Type: Single

Returns: Nullable<Single>

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Byte>

Extended Type: Byte

() : unit
Returns: Nullable<Byte>

this.n

Full Usage: this.n

Returns: Nullable<Byte>

Extended Type: Byte

Returns: Nullable<Byte>

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Int64>

Extended Type: Int64

() : unit
Returns: Nullable<Int64>

this.n

Full Usage: this.n

Returns: Nullable<Int64>

Extended Type: Int64

Returns: Nullable<Int64>

this.n ()

Full Usage: this.n ()

Parameters:
    () : unit

Returns: Nullable<Decimal>

Extended Type: Decimal

() : unit
Returns: Nullable<Decimal>

this.n

Full Usage: this.n

Returns: Nullable<Decimal>

Extended Type: Decimal

Returns: Nullable<Decimal>

Active patterns

Active pattern Description

(|Null|Value|) x

Full Usage: (|Null|Value|) x

Parameters:
Returns: Choice<unit, 'a>
x : Nullable<'a>
Returns: Choice<unit, 'a>