ReferenceExpression

Classnet10.0

📦 Aspire.Hosting v13.5.4

Represents an expression that might be made up of multiple resource properties. For example, a connection string might be made up of a host, port, and password from different endpoints.

namespace Aspire.Hosting.ApplicationModel;

public class ReferenceExpression
    : Aspire.Hosting.ApplicationModel.IExpressionValue,
      Aspire.Hosting.ApplicationModel.IManifestExpressionProvider,
      Aspire.Hosting.ApplicationModel.IValueProvider,
      Aspire.Hosting.ApplicationModel.IValueWithReferences
{
    // ...
}

IExpressionValue IManifestExpressionProvider IValueProvider IValueWithReferences

15 members

Remarks

A ReferenceExpression operates in one of two modes:

Value mode — a format string with interpolated IValueProvider parameters (e.g., "redis://{0}:{1}").
Conditional mode — a ternary-style expression that selects between two branch expressions based on the string value of a ReferenceExpression.Condition. Created via ReferenceExpression.CreateConditional.

Properties10

Conditionget

IValueProvider?

Gets the condition value provider whose result is compared to ReferenceExpression.MatchValue, or null when ReferenceExpression.IsConditional is false.

Formatget

string

The format string for this expression.

IsConditionalget

bool

Gets a value indicating whether this expression is a conditional expression that selects between two branches based on a condition.

ManifestExpressionsget

IReadOnlyList<string>

The manifest expressions for the parameters for the format string.

MatchValueget

string?

Gets the value that ReferenceExpression.Condition is compared against to select the ReferenceExpression.WhenTrue branch, or null when ReferenceExpression.IsConditional is false.

StringFormatsget

IReadOnlyList<string?>

The string formats of the parameters, e.g. "uri".

ValueExpressionget

string

The value expression for the format string.

ValueProvidersget

IReadOnlyList<IValueProvider>

The list of IValueProvider that will be used to resolve parameters for the format string.

WhenFalseget

ReferenceExpression?

Gets the expression to evaluate when ReferenceExpression.Condition does not evaluate to ReferenceExpression.MatchValue, or null when ReferenceExpression.IsConditional is false.

WhenTrueget

ReferenceExpression?

Gets the expression to evaluate when ReferenceExpression.Condition evaluates to ReferenceExpression.MatchValue, or null when ReferenceExpression.IsConditional is false.

View all properties

Methods4

Create(ExpressionInterpolatedStringHandler)static

ReferenceExpression

Creates a new instance of ReferenceExpression with the specified format and value providers.

CreateConditional(IValueProvider, string, ReferenceExpression, ReferenceExpression)static

ReferenceExpression

Creates a conditional ReferenceExpression that selects between two branch expressions based on the string value of a condition.

GetValueAsync(ValueProviderContext, CancellationToken)

ValueTask<string?>

Gets the value of the expression. The final string value after evaluating the format string and its parameters.

GetValueAsync(CancellationToken)ats export

ValueTask<string?>

Gets the value of the expression. The final string value after evaluating the format string and its parameters.

View all methods

Fields1

Emptystatic

ReferenceExpression

Represents an empty reference expression with no name, value providers, or arguments.

View all fields

Nested Types1

structExpressionInterpolatedStringHandler

Represents a handler for interpolated strings that contain expressions. Those expressions will either be literal strings or instances of types that implement both IValueProvider and IManifestExpressionProvider.