FSharpx.Extras


FSharpOption Type

Static members

Static member Description

FSharpOption.Aggregate(o, state, f)

Full Usage: FSharpOption.Aggregate(o, state, f)

Parameters:
    o : 'a option
    state : 'b
    f : Func<'b, 'a, 'b>

Returns: 'b

Evaluates the equivalent of Aggregate for an option

o : 'a option
state : 'b
f : Func<'b, 'a, 'b>
Returns: 'b

FSharpOption.Do(o, f)

Full Usage: FSharpOption.Do(o, f)

Parameters:
    o : 'a option
    f : Action<'a>

o : 'a option
f : Action<'a>

FSharpOption.GetOrDefault(o)

Full Usage: FSharpOption.GetOrDefault(o)

Parameters:
Returns: 'a
o : Option<'a>
Returns: 'a

FSharpOption.GetOrElse(o, other)

Full Usage: FSharpOption.GetOrElse(o, other)

Parameters:
    o : 'a option
    other : Func<'a>

Returns: 'a
o : 'a option
other : Func<'a>
Returns: 'a

FSharpOption.GetOrElse(o, other)

Full Usage: FSharpOption.GetOrElse(o, other)

Parameters:
    o : 'a option
    other : 'a

Returns: 'a
o : 'a option
other : 'a
Returns: 'a

FSharpOption.HasValue(o)

Full Usage: FSharpOption.HasValue(o)

Parameters:
Returns: bool
o : Option<'a>
Returns: bool

FSharpOption.Match(o, ifSome, ifNone)

Full Usage: FSharpOption.Match(o, ifSome, ifNone)

Parameters:
o : 'a option
ifSome : Action<'a>
ifNone : Action

FSharpOption.Match(o, ifSome, ifNone)

Full Usage: FSharpOption.Match(o, ifSome, ifNone)

Parameters:
    o : 'a option
    ifSome : Func<'a, 'b>
    ifNone : 'b

Returns: 'b
o : 'a option
ifSome : Func<'a, 'b>
ifNone : 'b
Returns: 'b

FSharpOption.Match(o, ifSome, ifNone)

Full Usage: FSharpOption.Match(o, ifSome, ifNone)

Parameters:
    o : 'a option
    ifSome : Func<'a, 'b>
    ifNone : Func<'b>

Returns: 'b
o : 'a option
ifSome : Func<'a, 'b>
ifNone : Func<'b>
Returns: 'b

FSharpOption.OrElse(o, other)

Full Usage: FSharpOption.OrElse(o, other)

Parameters:
    o : 'a option
    other : 'a option

Returns: 'a option

Gets the option if Some x, otherwise the supplied default value.

o : 'a option
other : 'a option
Returns: 'a option

FSharpOption.OrElseLazy(o, other)

Full Usage: FSharpOption.OrElseLazy(o, other)

Parameters:
    o : 'a option
    other : Lazy<'a option>

Returns: 'a option
o : 'a option
other : Lazy<'a option>
Returns: 'a option

FSharpOption.ParseByte(s, style, provider)

Full Usage: FSharpOption.ParseByte(s, style, provider)

Parameters:
Returns: byte option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: byte option

FSharpOption.ParseByte(s)

Full Usage: FSharpOption.ParseByte(s)

Parameters:
    s : string

Returns: byte option
s : string
Returns: byte option

FSharpOption.ParseDateTime(s, style, provider)

Full Usage: FSharpOption.ParseDateTime(s, style, provider)

Parameters:
Returns: DateTime option
s : string
style : DateTimeStyles
provider : IFormatProvider
Returns: DateTime option

FSharpOption.ParseDateTime(s)

Full Usage: FSharpOption.ParseDateTime(s)

Parameters:
    s : string

Returns: DateTime option
s : string
Returns: DateTime option

FSharpOption.ParseDateTimeOffset(s, style, provider)

Full Usage: FSharpOption.ParseDateTimeOffset(s, style, provider)

Parameters:
Returns: DateTimeOffset option
s : string
style : DateTimeStyles
provider : IFormatProvider
Returns: DateTimeOffset option

FSharpOption.ParseDateTimeOffset(s)

Full Usage: FSharpOption.ParseDateTimeOffset(s)

Parameters:
    s : string

Returns: DateTimeOffset option
s : string
Returns: DateTimeOffset option

FSharpOption.ParseDecimal(s, style, provider)

Full Usage: FSharpOption.ParseDecimal(s, style, provider)

Parameters:
Returns: decimal option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: decimal option

FSharpOption.ParseDecimal(s)

Full Usage: FSharpOption.ParseDecimal(s)

Parameters:
    s : string

Returns: decimal option
s : string
Returns: decimal option

FSharpOption.ParseDouble(s, style, provider)

Full Usage: FSharpOption.ParseDouble(s, style, provider)

Parameters:
Returns: float option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: float option

FSharpOption.ParseDouble(s)

Full Usage: FSharpOption.ParseDouble(s)

Parameters:
    s : string

Returns: float option
s : string
Returns: float option

FSharpOption.ParseFloat(s, style, provider)

Full Usage: FSharpOption.ParseFloat(s, style, provider)

Parameters:
Returns: float32 option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: float32 option

FSharpOption.ParseFloat(s)

Full Usage: FSharpOption.ParseFloat(s)

Parameters:
    s : string

Returns: float32 option
s : string
Returns: float32 option

FSharpOption.ParseInt(s, style, provider)

Full Usage: FSharpOption.ParseInt(s, style, provider)

Parameters:
Returns: int option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: int option

FSharpOption.ParseInt(s)

Full Usage: FSharpOption.ParseInt(s)

Parameters:
    s : string

Returns: int option
s : string
Returns: int option

FSharpOption.ParseInt16(s, style, provider)

Full Usage: FSharpOption.ParseInt16(s, style, provider)

Parameters:
Returns: int16 option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: int16 option

FSharpOption.ParseInt16(s)

Full Usage: FSharpOption.ParseInt16(s)

Parameters:
    s : string

Returns: int16 option
s : string
Returns: int16 option

FSharpOption.ParseInt64(s, style, provider)

Full Usage: FSharpOption.ParseInt64(s, style, provider)

Parameters:
Returns: int64 option
s : string
style : NumberStyles
provider : IFormatProvider
Returns: int64 option

FSharpOption.ParseInt64(s)

Full Usage: FSharpOption.ParseInt64(s)

Parameters:
    s : string

Returns: int64 option
s : string
Returns: int64 option

FSharpOption.Select(o, f)

Full Usage: FSharpOption.Select(o, f)

Parameters:
    o : 'a option
    f : Func<'a, 'b>

Returns: 'b option

Transforms an option value by using a specified mapping function

o : 'a option
f : Func<'a, 'b>
Returns: 'b option

FSharpOption.SelectMany(o, f, mapper)

Full Usage: FSharpOption.SelectMany(o, f, mapper)

Parameters:
    o : 'a option
    f : Func<'a, 'b option>
    mapper : Func<'a, 'b, 'c>

Returns: 'c option

Invokes a function on an optional value that itself yields an option, and then applies a mapping function

o : 'a option
f : Func<'a, 'b option>
mapper : Func<'a, 'b, 'c>
Returns: 'c option

FSharpOption.SelectMany(o, f)

Full Usage: FSharpOption.SelectMany(o, f)

Parameters:
    o : 'a option
    f : Func<'a, 'b option>

Returns: 'b option

Invokes a function on an optional value that itself yields an option

o : 'a option
f : Func<'a, 'b option>
Returns: 'b option

FSharpOption.Sequence(o)

Full Usage: FSharpOption.Sequence(o)

Parameters:
    o : 'a option list

Returns: 'a list option
o : 'a option list
Returns: 'a list option

FSharpOption.Some(a)

Full Usage: FSharpOption.Some(a)

Parameters:
    a : 'a

Returns: 'a option
a : 'a
Returns: 'a option

FSharpOption.SomeUnit

Full Usage: FSharpOption.SomeUnit

Returns: unit option
Returns: unit option

FSharpOption.ToArray(o)

Full Usage: FSharpOption.ToArray(o)

Parameters:
    o : 'a option

Returns: 'a[]

Converts the option to an array of length 0 or 1

o : 'a option
Returns: 'a[]

FSharpOption.ToFSharpChoice(o, other)

Full Usage: FSharpOption.ToFSharpChoice(o, other)

Parameters:
    o : 'a option
    other : 'b

Returns: Choice<'a, 'b>
o : 'a option
other : 'b
Returns: Choice<'a, 'b>

FSharpOption.ToFSharpList(o)

Full Usage: FSharpOption.ToFSharpList(o)

Parameters:
    o : 'a option

Returns: 'a list

Converts the option to a list of length 0 or 1

o : 'a option
Returns: 'a list

FSharpOption.ToFSharpOption(v)

Full Usage: FSharpOption.ToFSharpOption(v)

Parameters:
    v : 'a

Returns: 'a option
v : 'a
Returns: 'a option

FSharpOption.ToFSharpOption(n)

Full Usage: FSharpOption.ToFSharpOption(n)

Parameters:
Returns: 'a option
n : Nullable<'a>
Returns: 'a option

FSharpOption.ToFSharpResult(o, other)

Full Usage: FSharpOption.ToFSharpResult(o, other)

Parameters:
    o : 'a option
    other : 'b

Returns: Result<'a, 'b>
o : 'a option
other : 'b
Returns: Result<'a, 'b>

FSharpOption.ToNullable(o)

Full Usage: FSharpOption.ToNullable(o)

Parameters:
    o : 'a option

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

FSharpOption.Where(o, pred)

Full Usage: FSharpOption.Where(o, pred)

Parameters:
Returns: 'a option

Applies a predicate to the option. If the predicate returns true, returns Some x, otherwise None.

o : 'a option
pred : Predicate<'a>
Returns: 'a option