Logo fantomas

RangeHelpers Module

Functions and values

Function or value Description

RangeHelpers.absoluteZeroRange

Full Usage: RangeHelpers.absoluteZeroRange

Returns: Range

Range.range0 starts at line 1, column 0 This range starts at line 0, column 0

Returns: Range

RangeHelpers.isAbsoluteZero r

Full Usage: RangeHelpers.isAbsoluteZero r

Parameters:
Returns: bool

Whether a range is `absoluteZeroRange`, the range of the module of a file without code. A source has no line 0, so the start line says it. Reading `absoluteZeroRange` instead initializes it, which enters the compiler's `range.fs` through its `Range` module. Doing that while another thread enters the same file through its first parse can leave that parse with a null file index, as `ParserWarmupFixture` in `Fantomas.Core.Tests` explains.

r : Range
Returns: bool

RangeHelpers.isAdjacentTo r1 r2

Full Usage: RangeHelpers.isAdjacentTo r1 r2

Parameters:
Returns: bool

Whether `r2` starts exactly where `r1` ends, on the same line and in the same file. Nothing, not even a space, sits between them.

r1 : Range
r2 : Range
Returns: bool

RangeHelpers.rangeContainsRange a b

Full Usage: RangeHelpers.rangeContainsRange a b

Parameters:
Returns: bool

Checks if Range B is fully contained by Range A

a : Range
b : Range
Returns: bool

RangeHelpers.rangeEq

Full Usage: RangeHelpers.rangeEq

Returns: range -> range -> bool
Returns: range -> range -> bool

Type something to start searching.