SearchExpressionEvaluationHints
Hints provided to the SearchExpression runtime to specify how a certain SearchExpressionEvaluatorAttribute should be executed.
Read time 2 minutesLast updated 10 days ago
Definition
- Type: Enum
- Namespace: UnityEditor.Search
- Assembly: UnityEditor
[Flags]public enum SearchExpressionEvaluationHints
Remarks
Here is an example of an evaluator not supporting thread evaluation:
Examples
[Description("Returns asset paths corresponding to a list of instance ids")][SearchExpressionEvaluator("IdsToPaths", SearchExpressionEvaluationHints.ThreadNotSupported, SearchExpressionType.Iterable)]public static IEnumerable<SearchItem> IdsToPath(SearchExpressionContext c){ foreach (var idItem in c.args[0].Execute(c)) { if (SearchExpression.TryConvertToULong(idItem, out var idNum)) { var id = UnsafeUtility.As<ulong, EntityId>(ref idNum); var path = AssetDatabase.GetAssetPath(id); if (!string.IsNullOrEmpty(path)) { yield return SearchExpression.CreateItem(path, c.ResolveAlias("asset path")); } } }}
Fields
Value | Description |
|---|---|
| AlwaysExpand | Wehn evaluating a SearchExpression signifies that each ielded items could be another SearchExpression that needs evaluation. |
| Default | Default evaluation hints. Currently Default is that thread evaluation is supported (SearchExpressionEvaluationHints.ThreadSupported). |
| DoNotValidateArgsSignature | Specifies that the evaluator signature shouldn't be validated by the SearchExpression runtime thus allowing any number of parameters with any types to be passed to the evaluator. It becomes the job of the evaluator itself to validate its parameters. |
| DoNotValidateSignature | Specifies that the parameters of a SearchExpression shouldn't have their signature be validated. This is used mostly for meta programming evaluator lile apply{} where partial evaluator can be used as parameter. |
| ExpandSupported | Specifies that an evaluator might return SearchItem containing SearchExpression that supports expansin like groupBy{}. |
| ImplicitArgsLiterals | Specifies that an evaluator assumes its arguments are literal and will be used as such. |
| ThreadNotSupported | Specifies that an evaluator does not support worker thread evaluation and should only be evaluated in the main thread. This could be the case if an evaluator is using non-tread safe Unity API (like AssetDatabase). |
| ThreadSupported | Specifies that an evaluator supports being evaluated in a worker thread (that is not the main thread). This is the default evaluation hint. |