C# Class Microsoft.R.Support.Help.Functions.FunctionIndex

Contains index of function to package improving performance of locating package that contains the function documentation.
Afficher le fichier Open project: Microsoft/RTVS Class Usage Examples

Méthodes publiques

Méthode Description
BuildIndexAsync ( IPackageIndex packageIndex = null ) : System.Threading.Tasks.Task
GetFunctionInfo ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : IFunctionInfo

Retrieves function information by name. If information is not available, starts asynchronous retrieval of the function info from R and when the data becomes available invokes specified callback passing the parameter. This is used for async intellisense or function signature/parameter help.
GetFunctionInfoAsync ( string functionName, string packageName = null ) : Task
RegisterPackageFunctions ( IPackageInfo package ) : void

Private Methods

Méthode Description
FunctionIndex ( ICoreShell coreShell, IFunctionRdDataProvider rdDataProfider, IIntellisenseRSession host ) : System
GetFunctionInfoFromEngineAsync ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : Task

Fetches help on the function from R asynchronously. When function data is obtained, parsed and the function index is updated, method invokes infoReadyCallback callback passing the specified parameter. Callback method can now fetch function information from the index.
GetFunctionInfosFromRd ( string rdData ) : IReadOnlyList
GetQualifiedName ( string functionName, string packageName ) : string
RegisterFunction ( string functionName, string packageName ) : void
TryGetCachedFunctionInfo ( string functionName, string &packageName ) : IFunctionInfo

Attempts to retrieve function information from cache is a simple manner. Specifically, when function name is unique (then package name is irrelevant) or the package name is known.
UpdateIndex ( string functionName, string packageName, string rdData ) : void

Method Details

BuildIndexAsync() public méthode

public BuildIndexAsync ( IPackageIndex packageIndex = null ) : System.Threading.Tasks.Task
packageIndex IPackageIndex
Résultat System.Threading.Tasks.Task

GetFunctionInfo() public méthode

Retrieves function information by name. If information is not available, starts asynchronous retrieval of the function info from R and when the data becomes available invokes specified callback passing the parameter. This is used for async intellisense or function signature/parameter help.
public GetFunctionInfo ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : IFunctionInfo
functionName string
packageName string
infoReadyCallback string>.Action
parameter object
Résultat IFunctionInfo

GetFunctionInfoAsync() public méthode

public GetFunctionInfoAsync ( string functionName, string packageName = null ) : Task
functionName string
packageName string
Résultat Task

RegisterPackageFunctions() public méthode

public RegisterPackageFunctions ( IPackageInfo package ) : void
package IPackageInfo
Résultat void