Logo fantomas

Extras Module

Namespace: Internal.Utilities.Library
Assembly: Fantomas.FCS.dll

Types and nested modules

Type/Module Description

ArrayParallel

Specialized parallel functions for an array. Different from Array.Parallel as it will try to minimize the max degree of parallelism. Will flatten aggregate exceptions that contain one exception.

Async

Bits

Bool

Int32

Int64

IntMap

ListAssoc

ListParallel

ListSet

NameMap

NameSet (Module)

Pair

WeakMap

Zmap

Zset

DisposablesTracker

Track a set of resources to cleanup

Graph<'Data, 'Id>

IntMap<'T>

MaybeLazy<'T>

NameSet (Type)

NonNullSlot<'T>

In some cases we play games where we use 'null' as a more efficient representation in F#. The functions below are used to give initial values to mutable fields. This is an unsafe trick, as it relies on the fact that the type of values being placed into the slot never utilizes "null" as a representation. To be used with with care.

cache<'T>

Caches, mainly for free variables

Functions and values

Function or value Description

GetEnvInteger e dflt

Full Usage: GetEnvInteger e dflt

Parameters:
    e : string
    dflt : int

Returns: int
e : string
dflt : int
Returns: int

buildString f

Full Usage: buildString f

Parameters:
Returns: string

Buffer printing utility

f : StringBuilder -> unit
Returns: string

cacheOptByref cache f

Full Usage: cacheOptByref cache f

Parameters:
    cache : byref<'T option>
    f : unit -> 'T

Returns: 'T
Modifiers: inline
Type parameters: 'T
cache : byref<'T option>
f : unit -> 'T
Returns: 'T

cacheOptRef cache f

Full Usage: cacheOptRef cache f

Parameters:
    cache : 'a option ref
    f : unit -> 'a

Returns: 'a
Modifiers: inline
Type parameters: 'a
cache : 'a option ref
f : unit -> 'a
Returns: 'a

cached cache resF

Full Usage: cached cache resF

Parameters:
    cache : cache<'a>
    resF : unit -> 'a

Returns: 'a
Modifiers: inline
Type parameters: 'a (requires not struct)
cache : cache<'a>
resF : unit -> 'a
Returns: 'a

debug

Full Usage: debug

Returns: bool
Returns: bool

dispose x

Full Usage: dispose x

Parameters:
x : IDisposable

fold1Of2 f1 acc (a1, _a2)

Full Usage: fold1Of2 f1 acc (a1, _a2)

Parameters:
    f1 : 'a -> 'b -> 'c
    acc : 'a
    a1 : 'b
    _a2 : 'd

Returns: 'c
Type parameters: 'a, 'b, 'c, 'd
f1 : 'a -> 'b -> 'c
acc : 'a
a1 : 'b
_a2 : 'd
Returns: 'c

foldPair (f1, f2) acc (a1, a2)

Full Usage: foldPair (f1, f2) acc (a1, a2)

Parameters:
    f1 : 'a -> 'b -> 'c
    f2 : 'c -> 'd -> 'e
    acc : 'a
    a1 : 'b
    a2 : 'd

Returns: 'e
Type parameters: 'a, 'b, 'c, 'd, 'e
f1 : 'a -> 'b -> 'c
f2 : 'c -> 'd -> 'e
acc : 'a
a1 : 'b
a2 : 'd
Returns: 'e

foldQuadruple (f1, f2, f3, f4) acc (a1, a2, a3, a4)

Full Usage: foldQuadruple (f1, f2, f3, f4) acc (a1, a2, a3, a4)

Parameters:
    f1 : 'a -> 'b -> 'c
    f2 : 'c -> 'd -> 'e
    f3 : 'e -> 'f -> 'g
    f4 : 'g -> 'h -> 'i
    acc : 'a
    a1 : 'b
    a2 : 'd
    a3 : 'f
    a4 : 'h

Returns: 'i
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i
f1 : 'a -> 'b -> 'c
f2 : 'c -> 'd -> 'e
f3 : 'e -> 'f -> 'g
f4 : 'g -> 'h -> 'i
acc : 'a
a1 : 'b
a2 : 'd
a3 : 'f
a4 : 'h
Returns: 'i

foldTriple (f1, f2, f3) acc (a1, a2, a3)

Full Usage: foldTriple (f1, f2, f3) acc (a1, a2, a3)

Parameters:
    f1 : 'a -> 'b -> 'c
    f2 : 'c -> 'd -> 'e
    f3 : 'e -> 'f -> 'g
    acc : 'a
    a1 : 'b
    a2 : 'd
    a3 : 'f

Returns: 'g
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f, 'g
f1 : 'a -> 'b -> 'c
f2 : 'c -> 'd -> 'e
f3 : 'e -> 'f -> 'g
acc : 'a
a1 : 'b
a2 : 'd
a3 : 'f
Returns: 'g

isEnvVarSet s

Full Usage: isEnvVarSet s

Parameters:
    s : string

Returns: bool
s : string
Returns: bool

map1Of2 f (a1, a2)

Full Usage: map1Of2 f (a1, a2)

Parameters:
    f : 'a -> 'b
    a1 : 'a
    a2 : 'c

Returns: 'b * 'c
Type parameters: 'a, 'b, 'c
f : 'a -> 'b
a1 : 'a
a2 : 'c
Returns: 'b * 'c

map1Of3 f (a1, a2, a3)

Full Usage: map1Of3 f (a1, a2, a3)

Parameters:
    f : 'a -> 'b
    a1 : 'a
    a2 : 'c
    a3 : 'd

Returns: 'b * 'c * 'd
Type parameters: 'a, 'b, 'c, 'd
f : 'a -> 'b
a1 : 'a
a2 : 'c
a3 : 'd
Returns: 'b * 'c * 'd

map2Of2 f (a1, a2)

Full Usage: map2Of2 f (a1, a2)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'a

Returns: 'c * 'b
Type parameters: 'a, 'b, 'c
f : 'a -> 'b
a1 : 'c
a2 : 'a
Returns: 'c * 'b

map2Of3 f (a1, a2, a3)

Full Usage: map2Of3 f (a1, a2, a3)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'a
    a3 : 'd

Returns: 'c * 'b * 'd
Type parameters: 'a, 'b, 'c, 'd
f : 'a -> 'b
a1 : 'c
a2 : 'a
a3 : 'd
Returns: 'c * 'b * 'd

map3Of3 f (a1, a2, a3)

Full Usage: map3Of3 f (a1, a2, a3)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'd
    a3 : 'a

Returns: 'c * 'd * 'b
Type parameters: 'a, 'b, 'c, 'd
f : 'a -> 'b
a1 : 'c
a2 : 'd
a3 : 'a
Returns: 'c * 'd * 'b

map3Of4 f (a1, a2, a3, a4)

Full Usage: map3Of4 f (a1, a2, a3, a4)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'd
    a3 : 'a
    a4 : 'e

Returns: 'c * 'd * 'b * 'e
Type parameters: 'a, 'b, 'c, 'd, 'e
f : 'a -> 'b
a1 : 'c
a2 : 'd
a3 : 'a
a4 : 'e
Returns: 'c * 'd * 'b * 'e

map4Of4 f (a1, a2, a3, a4)

Full Usage: map4Of4 f (a1, a2, a3, a4)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'd
    a3 : 'e
    a4 : 'a

Returns: 'c * 'd * 'e * 'b
Type parameters: 'a, 'b, 'c, 'd, 'e
f : 'a -> 'b
a1 : 'c
a2 : 'd
a3 : 'e
a4 : 'a
Returns: 'c * 'd * 'e * 'b

map5Of5 f (a1, a2, a3, a4, a5)

Full Usage: map5Of5 f (a1, a2, a3, a4, a5)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'd
    a3 : 'e
    a4 : 'f
    a5 : 'a

Returns: 'c * 'd * 'e * 'f * 'b
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f
f : 'a -> 'b
a1 : 'c
a2 : 'd
a3 : 'e
a4 : 'f
a5 : 'a
Returns: 'c * 'd * 'e * 'f * 'b

map6Of6 f (a1, a2, a3, a4, a5, a6)

Full Usage: map6Of6 f (a1, a2, a3, a4, a5, a6)

Parameters:
    f : 'a -> 'b
    a1 : 'c
    a2 : 'd
    a3 : 'e
    a4 : 'f
    a5 : 'g
    a6 : 'a

Returns: 'c * 'd * 'e * 'f * 'g * 'b
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f, 'g
f : 'a -> 'b
a1 : 'c
a2 : 'd
a3 : 'e
a4 : 'f
a5 : 'g
a6 : 'a
Returns: 'c * 'd * 'e * 'f * 'g * 'b

mapFoldFst f s (x, y)

Full Usage: mapFoldFst f s (x, y)

Parameters:
    f : 'a -> 'b -> 'c * 'd
    s : 'a
    x : 'b
    y : 'e

Returns: ('c * 'e) * 'd
Type parameters: 'a, 'b, 'c, 'd, 'e
f : 'a -> 'b -> 'c * 'd
s : 'a
x : 'b
y : 'e
Returns: ('c * 'e) * 'd

mapFoldSnd f s (x, y)

Full Usage: mapFoldSnd f s (x, y)

Parameters:
    f : 'a -> 'b -> 'c * 'd
    s : 'a
    x : 'e
    y : 'b

Returns: ('e * 'c) * 'd
Type parameters: 'a, 'b, 'c, 'd, 'e
f : 'a -> 'b -> 'c * 'd
s : 'a
x : 'e
y : 'b
Returns: ('e * 'c) * 'd

mapPair (f1, f2) (a1, a2)

Full Usage: mapPair (f1, f2) (a1, a2)

Parameters:
    f1 : 'a -> 'b
    f2 : 'c -> 'd
    a1 : 'a
    a2 : 'c

Returns: 'b * 'd
Type parameters: 'a, 'b, 'c, 'd
f1 : 'a -> 'b
f2 : 'c -> 'd
a1 : 'a
a2 : 'c
Returns: 'b * 'd

mapQuadruple (f1, f2, f3, f4) (a1, a2, a3, a4)

Full Usage: mapQuadruple (f1, f2, f3, f4) (a1, a2, a3, a4)

Parameters:
    f1 : 'a -> 'b
    f2 : 'c -> 'd
    f3 : 'e -> 'f
    f4 : 'g -> 'h
    a1 : 'a
    a2 : 'c
    a3 : 'e
    a4 : 'g

Returns: 'b * 'd * 'f * 'h
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h
f1 : 'a -> 'b
f2 : 'c -> 'd
f3 : 'e -> 'f
f4 : 'g -> 'h
a1 : 'a
a2 : 'c
a3 : 'e
a4 : 'g
Returns: 'b * 'd * 'f * 'h

mapTriple (f1, f2, f3) (a1, a2, a3)

Full Usage: mapTriple (f1, f2, f3) (a1, a2, a3)

Parameters:
    f1 : 'a -> 'b
    f2 : 'c -> 'd
    f3 : 'e -> 'f
    a1 : 'a
    a2 : 'c
    a3 : 'e

Returns: 'b * 'd * 'f
Type parameters: 'a, 'b, 'c, 'd, 'e, 'f
f1 : 'a -> 'b
f2 : 'c -> 'd
f3 : 'e -> 'f
a1 : 'a
a2 : 'c
a3 : 'e
Returns: 'b * 'd * 'f

newCache ()

Full Usage: newCache ()

Parameters:
    () : unit

Returns: cache<'a>
Type parameters: 'a (requires not struct)
() : unit
Returns: cache<'a>

nullableSlotEmpty ()

Full Usage: nullableSlotEmpty ()

Parameters:
    () : unit

Returns: NonNullSlot<'T>
Type parameters: 'T (requires not struct)
() : unit
Returns: NonNullSlot<'T>

nullableSlotFull x

Full Usage: nullableSlotFull x

Parameters:
    x : 'a

Returns: NonNullSlot<'a>
Type parameters: 'a (requires not struct)
x : 'a
Returns: NonNullSlot<'a>

p13 (x, _y, _z)

Full Usage: p13 (x, _y, _z)

Parameters:
    x : 'a
    _y : 'b
    _z : 'c

Returns: 'a
Type parameters: 'a, 'b, 'c
x : 'a
_y : 'b
_z : 'c
Returns: 'a

p14 (x1, _x2, _x3, _x4)

Full Usage: p14 (x1, _x2, _x3, _x4)

Parameters:
    x1 : 'a
    _x2 : 'b
    _x3 : 'c
    _x4 : 'd

Returns: 'a
Type parameters: 'a, 'b, 'c, 'd
x1 : 'a
_x2 : 'b
_x3 : 'c
_x4 : 'd
Returns: 'a

p15 (x1, _x2, _x3, _x4, _x5)

Full Usage: p15 (x1, _x2, _x3, _x4, _x5)

Parameters:
    x1 : 'a
    _x2 : 'b
    _x3 : 'c
    _x4 : 'd
    _x5 : 'e

Returns: 'a
Type parameters: 'a, 'b, 'c, 'd, 'e
x1 : 'a
_x2 : 'b
_x3 : 'c
_x4 : 'd
_x5 : 'e
Returns: 'a

p23 (_x, y, _z)

Full Usage: p23 (_x, y, _z)

Parameters:
    _x : 'a
    y : 'b
    _z : 'c

Returns: 'b
Type parameters: 'a, 'b, 'c
_x : 'a
y : 'b
_z : 'c
Returns: 'b

p24 (_x1, x2, _x3, _x4)

Full Usage: p24 (_x1, x2, _x3, _x4)

Parameters:
    _x1 : 'a
    x2 : 'b
    _x3 : 'c
    _x4 : 'd

Returns: 'b
Type parameters: 'a, 'b, 'c, 'd
_x1 : 'a
x2 : 'b
_x3 : 'c
_x4 : 'd
Returns: 'b

p25 (_x1, x2, _x3, _x4, _x5)

Full Usage: p25 (_x1, x2, _x3, _x4, _x5)

Parameters:
    _x1 : 'a
    x2 : 'b
    _x3 : 'c
    _x4 : 'd
    _x5 : 'e

Returns: 'b
Type parameters: 'a, 'b, 'c, 'd, 'e
_x1 : 'a
x2 : 'b
_x3 : 'c
_x4 : 'd
_x5 : 'e
Returns: 'b

p33 (_x, _y, z)

Full Usage: p33 (_x, _y, z)

Parameters:
    _x : 'a
    _y : 'b
    z : 'c

Returns: 'c
Type parameters: 'a, 'b, 'c
_x : 'a
_y : 'b
z : 'c
Returns: 'c

p34 (_x1, _x2, x3, _x4)

Full Usage: p34 (_x1, _x2, x3, _x4)

Parameters:
    _x1 : 'a
    _x2 : 'b
    x3 : 'c
    _x4 : 'd

Returns: 'c
Type parameters: 'a, 'b, 'c, 'd
_x1 : 'a
_x2 : 'b
x3 : 'c
_x4 : 'd
Returns: 'c

p35 (_x1, _x2, x3, _x4, _x5)

Full Usage: p35 (_x1, _x2, x3, _x4, _x5)

Parameters:
    _x1 : 'a
    _x2 : 'b
    x3 : 'c
    _x4 : 'd
    _x5 : 'e

Returns: 'c
Type parameters: 'a, 'b, 'c, 'd, 'e
_x1 : 'a
_x2 : 'b
x3 : 'c
_x4 : 'd
_x5 : 'e
Returns: 'c

p44 (_x1, _x2, _x3, x4)

Full Usage: p44 (_x1, _x2, _x3, x4)

Parameters:
    _x1 : 'a
    _x2 : 'b
    _x3 : 'c
    x4 : 'd

Returns: 'd
Type parameters: 'a, 'b, 'c, 'd
_x1 : 'a
_x2 : 'b
_x3 : 'c
x4 : 'd
Returns: 'd

p45 (_x1, _x2, _x3, x4, _x5)

Full Usage: p45 (_x1, _x2, _x3, x4, _x5)

Parameters:
    _x1 : 'a
    _x2 : 'b
    _x3 : 'c
    x4 : 'd
    _x5 : 'e

Returns: 'd
Type parameters: 'a, 'b, 'c, 'd, 'e
_x1 : 'a
_x2 : 'b
_x3 : 'c
x4 : 'd
_x5 : 'e
Returns: 'd

p55 (_x1, _x2, _x3, _x4, x5)

Full Usage: p55 (_x1, _x2, _x3, _x4, x5)

Parameters:
    _x1 : 'a
    _x2 : 'b
    _x3 : 'c
    _x4 : 'd
    x5 : 'e

Returns: 'e
Type parameters: 'a, 'b, 'c, 'd, 'e
_x1 : 'a
_x2 : 'b
_x3 : 'c
_x4 : 'd
x5 : 'e
Returns: 'e

pair a b

Full Usage: pair a b

Parameters:
    a : 'a
    b : 'b

Returns: 'a * 'b
Type parameters: 'a, 'b
a : 'a
b : 'b
Returns: 'a * 'b

progress

Full Usage: progress

Returns: bool
Returns: bool

tracking

Full Usage: tracking

Returns: bool
Returns: bool

tryGetCacheValue cache

Full Usage: tryGetCacheValue cache

Parameters:
Returns: NonNullSlot<'a> voption
Modifiers: inline
Type parameters: 'a (requires not struct)
cache : cache<'a>
Returns: NonNullSlot<'a> voption

verbose

Full Usage: verbose

Returns: bool
Returns: bool

vsnd arg1

Full Usage: vsnd arg1

Parameters:
    arg0 : 'T * 'T

Returns: 'T
Modifiers: inline
Type parameters: 'T
arg0 : 'T * 'T
Returns: 'T

writeViaBuffer os f

Full Usage: writeViaBuffer os f

Parameters:

Writing to output stream via a string buffer.

os : TextWriter
f : StringBuilder -> unit

Type extensions

Type extension Description

this.AppendString

Full Usage: this.AppendString

Parameters:
    value : string

Like Append, but returns unit

Extended Type: StringBuilder

value : string

Type something to start searching.