Header menu logo fantomas

PervasiveAutoOpens Module

Types

Type Description

'T MaybeNull

Indicates that a type may be null. 'MaybeNull' is used internally in the F# compiler as replacement for 'string?' to align with FS-1060.

Functions and values

Function or value Description

x === y

Full Usage: x === y

Parameters:
    x : 'a
    y : 'a

Returns: bool
Modifiers: inline
Type parameters: 'a
x : 'a
y : 'a
Returns: bool

x >>>& n

Full Usage: x >>>& n

Parameters:
    x : int32
    n : int32

Returns: int32

Logical shift right treating int32 as unsigned integer. Code that uses this should probably be adjusted to use unsigned integer types.

x : int32
n : int32
Returns: int32

LOH_SIZE_THRESHOLD_BYTES

Full Usage: LOH_SIZE_THRESHOLD_BYTES

Returns: int

Per the docs the threshold for the Large Object Heap is 85000 bytes: https://learn.microsoft.com/dotnet/standard/garbage-collection/large-object-heap#how-an-object-ends-up-on-the-large-object-heap-and-how-gc-handles-them We set the limit to be 80k to account for larger pointer sizes for when F# is running 64-bit.

Returns: int

foldOn p f z x

Full Usage: foldOn p f z x

Parameters:
    p : 'a -> 'b
    f : 'c -> 'b -> 'd
    z : 'c
    x : 'a

Returns: 'd
p : 'a -> 'b
f : 'c -> 'b -> 'd
z : 'c
x : 'a
Returns: 'd

getHole r

Full Usage: getHole r

Parameters:
    r : 'a option ref

Returns: 'a

Get an initialization hole

r : 'a option ref
Returns: 'a

isNil l

Full Usage: isNil l

Parameters:
    l : 'a list

Returns: bool
Modifiers: inline
Type parameters: 'a
l : 'a list
Returns: bool

isNilOrSingleton l

Full Usage: isNilOrSingleton l

Parameters:
    l : 'a list

Returns: bool
Modifiers: inline
Type parameters: 'a

Returns true if the list has less than 2 elements. Otherwise false.

l : 'a list
Returns: bool

isNotNull x

Full Usage: isNotNull x

Parameters:
    x : 'T

Returns: bool
Modifiers: inline
Type parameters: 'T

Returns true if the argument is non-null.

x : 'T
Returns: bool

isSingleton l

Full Usage: isSingleton l

Parameters:
    l : 'a list

Returns: bool
Modifiers: inline
Type parameters: 'a

Returns true if the list contains exactly 1 element. Otherwise false.

l : 'a list
Returns: bool

nonNull x

Full Usage: nonNull x

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T

Asserts the argument is non-null and raises an exception if it is

x : 'T MaybeNull
Returns: 'T

notFound ()

Full Usage: notFound ()

Parameters:
    () : unit

Returns: 'a
() : unit
Returns: 'a

notlazy v

Full Usage: notlazy v

Parameters:
    v : 'a

Returns: InterruptibleLazy<'a>
v : 'a
Returns: InterruptibleLazy<'a>

nullArgCheck paramName x

Full Usage: nullArgCheck paramName x

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T

Checks the argument is non-null

paramName : string
x : 'T MaybeNull
Returns: 'T

reportTime

Full Usage: reportTime

Returns: string -> unit
Returns: string -> unit

Type extensions

Type extension Description

this.EndsWithOrdinal

Full Usage: this.EndsWithOrdinal

Parameters:
    value : string

Returns: bool
Modifiers: inline

Extended Type: String

value : string
Returns: bool

this.EndsWithOrdinalIgnoreCase

Full Usage: this.EndsWithOrdinalIgnoreCase

Parameters:
    value : string

Returns: bool
Modifiers: inline

Extended Type: String

value : string
Returns: bool

this.IndexOfOrdinal

Full Usage: this.IndexOfOrdinal

Parameters:
    value : string

Returns: int
Modifiers: inline

Extended Type: String

value : string
Returns: int

this.IndexOfOrdinal

Full Usage: this.IndexOfOrdinal

Parameters:
    value : string
    startIndex : int

Returns: int
Modifiers: inline

Extended Type: String

value : string
startIndex : int
Returns: int

this.IndexOfOrdinal

Full Usage: this.IndexOfOrdinal

Parameters:
    value : string
    startIndex : int
    count : int

Returns: int
Modifiers: inline

Extended Type: String

value : string
startIndex : int
count : int
Returns: int

Async.RunImmediate(computation, ?cancellationToken)

Full Usage: Async.RunImmediate(computation, ?cancellationToken)

Parameters:
Returns: 'T

Runs the computation synchronously, always starting on the current thread.

Extended Type: Async

computation : Async<'T>
?cancellationToken : CancellationToken
Returns: 'T

this.StartsWithOrdinal

Full Usage: this.StartsWithOrdinal

Parameters:
    value : string

Returns: bool
Modifiers: inline

Extended Type: String

value : string
Returns: bool

Active patterns

Active pattern Description

(|InterruptibleLazy|) l

Full Usage: (|InterruptibleLazy|) l

Parameters:
Returns: 'T
l : InterruptibleLazy<'T>
Returns: 'T

(|NonNullQuick|) arg1

Full Usage: (|NonNullQuick|) arg1

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T

Asserts the argument is non-null and raises an exception if it is

arg0 : 'T MaybeNull
Returns: 'T

(|Null|NonNull|) arg1

Full Usage: (|Null|NonNull|) arg1

Parameters:
Returns: Choice<unit, 'T>
Modifiers: inline
Type parameters: 'T

Match on the nullness of an argument.

arg0 : 'T MaybeNull
Returns: Choice<unit, 'T>

(|RecoverableException|_|) exn

Full Usage: (|RecoverableException|_|) exn

Parameters:
Returns: Exception voption
exn : Exception
Returns: Exception voption

Type something to start searching.