Header menu logo F# Compiler Guide

FSharpParseFileResults Type

Represents the results of parsing an F# file and a set of analysis operations based on the parse tree alone.

Instance members

Instance member Description

this.DependencyFiles

Full Usage: this.DependencyFiles

Returns: string[]

When these files change then the build is invalid

Returns: string[]

this.Diagnostics

Full Usage: this.Diagnostics

Returns: FSharpDiagnostic[]

Get the errors and warnings for the parse

Returns: FSharpDiagnostic[]

this.FileName

Full Usage: this.FileName

Returns: string

Name of the file for which this information were created

Returns: string

this.FindParameterLocations

Full Usage: this.FindParameterLocations

Parameters:
Returns: ParameterLocations option

Notable parse info for ParameterInfo at a given location

pos : pos
Returns: ParameterLocations option

this.GetAllArgumentsForFunctionApplicationAtPosition

Full Usage: this.GetAllArgumentsForFunctionApplicationAtPosition

Parameters:
Returns: range list option

Gets the ranges of all arguments, if they can be found, for a function application at the given position.

pos : pos
Returns: range list option

this.GetNavigationItems

Full Usage: this.GetNavigationItems

Returns: NavigationItems

Get declared items and the selected item at the specified location

Returns: NavigationItems

this.IsBindingALambdaAtPosition

Full Usage: this.IsBindingALambdaAtPosition

Parameters:
Returns: bool

Determines if the binding at the given position is bound to a lambda expression

arg0 : pos
Returns: bool

this.IsPosContainedInApplication

Full Usage: this.IsPosContainedInApplication

Parameters:
Returns: bool

Determines if the given position is inside a function or method application.

pos : pos
Returns: bool

this.IsPositionContainedInACurriedParameter

Full Usage: this.IsPositionContainedInACurriedParameter

Parameters:
Returns: bool

Determines if the given position is contained within a curried parameter in a binding.

pos : pos
Returns: bool

this.IsPositionWithinRecordDefinition

Full Usage: this.IsPositionWithinRecordDefinition

Parameters:
Returns: bool

Determines if the given position is bound to a record definition

arg0 : pos
Returns: bool

this.IsPositionWithinTypeDefinition

Full Usage: this.IsPositionWithinTypeDefinition

Parameters:
Returns: bool

Determines if the given position is bound to a type definition

arg0 : pos
Returns: bool

this.IsTypeAnnotationGivenAtPosition

Full Usage: this.IsTypeAnnotationGivenAtPosition

Parameters:
Returns: bool

Determines if the expression or pattern at the given position has a type annotation

arg0 : pos
Returns: bool

this.IsTypeName

Full Usage: this.IsTypeName

Parameters:
Returns: bool

Determines if the range points to a type name in the type definition.

range : range
Returns: bool

this.ParseHadErrors

Full Usage: this.ParseHadErrors

Returns: bool

Indicates if any errors occurred during the parse

Returns: bool

this.ParseTree

Full Usage: this.ParseTree

Returns: ParsedInput

The syntax tree resulting from the parse

Returns: ParsedInput

this.TryIdentOfPipelineContainingPosAndNumArgsApplied

Full Usage: this.TryIdentOfPipelineContainingPosAndNumArgsApplied

Parameters:
Returns: (Ident * int) option

Attempts to find an Ident of a pipeline containing the given position, and the number of args already applied in that pipeline. For example, '[1..10] |> List.map ' would give back the ident of '|>' and 1, because it applied 1 arg (the list) to 'List.map'.

pos : pos
Returns: (Ident * int) option

this.TryRangeOfExprInYieldOrReturn

Full Usage: this.TryRangeOfExprInYieldOrReturn

Parameters:
Returns: range option

Attempts to find the range of an expression `expr` contained in a `yield expr` or `return expr` expression (and bang-variants).

pos : pos
Returns: range option

this.TryRangeOfExpressionBeingDereferencedContainingPos

Full Usage: this.TryRangeOfExpressionBeingDereferencedContainingPos

Parameters:
    expressionPos : pos

Returns: range option

Gets the range of an expression being dereferenced. For `!expr`, gives the range of `expr`

expressionPos : pos
Returns: range option

this.TryRangeOfFunctionOrMethodBeingApplied

Full Usage: this.TryRangeOfFunctionOrMethodBeingApplied

Parameters:
Returns: range option

Attempts to find the range of a function or method that is being applied. Also accounts for functions in pipelines.

pos : pos
Returns: range option

this.TryRangeOfNameOfNearestOuterBindingContainingPos

Full Usage: this.TryRangeOfNameOfNearestOuterBindingContainingPos

Parameters:
Returns: range option

Attempts to find the range of the name of the nearest outer binding that contains a given position.

pos : pos
Returns: range option

this.TryRangeOfParenEnclosingOpEqualsGreaterUsage

Full Usage: this.TryRangeOfParenEnclosingOpEqualsGreaterUsage

Parameters:
    opGreaterEqualPos : pos

Returns: (range * range * range) option

Attempts to find the range of an attempted lambda expression or pattern, the argument range, and the expr range when writing a C#-style "lambda" (which is actually an operator application)

opGreaterEqualPos : pos
Returns: (range * range * range) option

this.TryRangeOfRecordExpressionContainingPos

Full Usage: this.TryRangeOfRecordExpressionContainingPos

Parameters:
Returns: range option

Attempts to find the range of a record expression containing the given position.

pos : pos
Returns: range option

this.TryRangeOfRefCellDereferenceContainingPos

Full Usage: this.TryRangeOfRefCellDereferenceContainingPos

Parameters:
    expressionPos : pos

Returns: range option

Given the position of an expression, attempts to find the range of the '!' in a derefence operation of that expression, like: '!expr', '!(expr)', etc.

expressionPos : pos
Returns: range option

this.TryRangeOfReturnTypeHint

Full Usage: this.TryRangeOfReturnTypeHint

Parameters:
    symbolUseStart : pos
    ?skipLambdas : bool

Returns: range option

Gets the range of where a return type hint could be placed for a function binding. This will be right in front of the equals sign. Returns None if type annotation is present.

symbolUseStart : pos
?skipLambdas : bool
Returns: range option

this.TryRangeOfStringInterpolationContainingPos

Full Usage: this.TryRangeOfStringInterpolationContainingPos

Parameters:
Returns: range option

Attempts to find the range of the string interpolation that contains a given position.

pos : pos
Returns: range option

this.ValidateBreakpointLocation

Full Usage: this.ValidateBreakpointLocation

Parameters:
Returns: range option

Return the inner-most range associated with a possible breakpoint location

pos : pos
Returns: range option

Type something to start searching.