C# Class Microsoft.R.StackTracing.RStackFrameExtensions

Afficher le fichier Open project: Microsoft/RTVS

Méthodes publiques

Méthode	Description
DescribeChildrenAsync ( this frame, REvaluationResultProperties properties, string repr, int maxCount = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Like RSessionExtensions.DescribeChildrenAsync, but returns children of this environment. If this method is called on a stale frame (i.e if call stack has changed since the RSessionExtensions.TracebackAsync call that produced this frame), the result is undefined - the method can throw RException, or produce meaningless output.
DescribeEnvironmentAsync ( this frame, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Same as DescribeEnvironmentAsync(IRStackFrame, REvaluationResultProperties, CancellationToken), but the only `properties` that are fetched are those that are necessary to invoke REvaluationResultInfoExtensions.DescribeChildrenAsync on the returned value.
DescribeEnvironmentAsync ( this frame, REvaluationResultProperties properties, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Produces an object describing this frame's environment. REvaluationResultInfoExtensions.DescribeChildrenAsync method can then be used to retrieve the variables in the frame. There is no guarantee that the returned evaluation result is IRValueInfo. Retrieving the frame environment involves evaluating EnvironmentExpression, and like any evaluation, it can fail. Caller should check for IRErrorInfo and handle it accordingly. However, it is never IRPromiseInfo or IRActiveBindingInfo. If this method is called on a stale frame (i.e if call stack has changed since the RSessionExtensions.TracebackAsync call that produced this frame), the result is undefined, and can be an error result, or contain unrelated data.
EvaluateAndDescribeAsync ( this frame, string expression, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Same as EvaluateAndDescribeAsync(IRStackFrame, string, string, REvaluationResultProperties, string, CancellationToken), but uses for `name`.
EvaluateAndDescribeAsync ( this frame, string expression, string name, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Same as Microsoft.R.DataInspection.RSessionExtensions.EvaluateAndDescribeAsync(string, string, string, REvaluationResultProperties, int?, CancellationToken), but passes EnvironmentExpression of this frame as `environmentExpression` argument,
TryEvaluateAndDescribeAsync ( this frame, string expression, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Same as TryEvaluateAndDescribeAsync(IRStackFrame, string, string, REvaluationResultProperties, string, CancellationToken), but uses for `name`.
TryEvaluateAndDescribeAsync ( this frame, string expression, string name, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Same as Microsoft.R.DataInspection.RSessionExtensions.TryEvaluateAndDescribeAsync(string, string, string, REvaluationResultProperties, int?, CancellationToken), but passes EnvironmentExpression of this frame as `environmentExpression` argument,

Method Details

DescribeChildrenAsync() public static méthode

Like RSessionExtensions.DescribeChildrenAsync, but returns children of this environment.

If this method is called on a stale frame (i.e if call stack has changed since the RSessionExtensions.TracebackAsync call that produced this frame), the result is undefined - the method can throw RException, or produce meaningless output.

public static DescribeChildrenAsync ( this frame, REvaluationResultProperties properties, string repr, int maxCount = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
frame	this
properties	REvaluationResultProperties
repr	string
maxCount	int
cancellationToken	System.Threading.CancellationToken
Résultat	Task>

DescribeEnvironmentAsync() public static méthode

Same as DescribeEnvironmentAsync(IRStackFrame, REvaluationResultProperties, CancellationToken), but the only properties that are fetched are those that are necessary to invoke REvaluationResultInfoExtensions.DescribeChildrenAsync on the returned value.

public static DescribeEnvironmentAsync ( this frame, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
cancellationToken	System.Threading.CancellationToken
Résultat	Task

DescribeEnvironmentAsync() public static méthode

Produces an object describing this frame's environment. REvaluationResultInfoExtensions.DescribeChildrenAsync method can then be used to retrieve the variables in the frame.

There is no guarantee that the returned evaluation result is IRValueInfo. Retrieving the frame environment involves evaluating EnvironmentExpression, and like any evaluation, it can fail. Caller should check for IRErrorInfo and handle it accordingly. However, it is never IRPromiseInfo or IRActiveBindingInfo.

If this method is called on a stale frame (i.e if call stack has changed since the RSessionExtensions.TracebackAsync call that produced this frame), the result is undefined, and can be an error result, or contain unrelated data.

public static DescribeEnvironmentAsync ( this frame, REvaluationResultProperties properties, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
properties	REvaluationResultProperties	/// Which properties of the returned object should be provided. Note that it should include at least the following flags /// argument value in order for to be working. ///
cancellationToken	System.Threading.CancellationToken
Résultat	Task

EvaluateAndDescribeAsync() public static méthode

Same as EvaluateAndDescribeAsync(IRStackFrame, string, string, REvaluationResultProperties, string, CancellationToken), but uses for name.

public static EvaluateAndDescribeAsync ( this frame, string expression, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
expression	string
properties	REvaluationResultProperties
repr	string
cancellationToken	System.Threading.CancellationToken
Résultat	Task

EvaluateAndDescribeAsync() public static méthode

Same as Microsoft.R.DataInspection.RSessionExtensions.EvaluateAndDescribeAsync(string, string, string, REvaluationResultProperties, int?, CancellationToken), but passes EnvironmentExpression of this frame as environmentExpression argument,

public static EvaluateAndDescribeAsync ( this frame, string expression, string name, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
expression	string
name	string
properties	REvaluationResultProperties
repr	string
cancellationToken	System.Threading.CancellationToken
Résultat	Task

TryEvaluateAndDescribeAsync() public static méthode

Same as TryEvaluateAndDescribeAsync(IRStackFrame, string, string, REvaluationResultProperties, string, CancellationToken), but uses for name.

public static TryEvaluateAndDescribeAsync ( this frame, string expression, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
expression	string
properties	REvaluationResultProperties
repr	string
cancellationToken	System.Threading.CancellationToken
Résultat	Task

TryEvaluateAndDescribeAsync() public static méthode

Same as Microsoft.R.DataInspection.RSessionExtensions.TryEvaluateAndDescribeAsync(string, string, string, REvaluationResultProperties, int?, CancellationToken), but passes EnvironmentExpression of this frame as environmentExpression argument,

public static TryEvaluateAndDescribeAsync ( this frame, string expression, string name, REvaluationResultProperties properties, string repr, CancellationToken cancellationToken = default(CancellationToken) ) : Task
frame	this
expression	string
name	string
properties	REvaluationResultProperties
repr	string
cancellationToken	System.Threading.CancellationToken
Résultat	Task