Show / Hide Table of Contents

    Struct SuggestionContext

    The context to provide suggestions for.

    Namespace: QFSW.QC
    Assembly: QFSW.QC.dll
    Syntax
    public struct SuggestionContext

    Fields

    Depth

    The depth of the suggestion context.

    Declaration
    public int Depth
    Field Value
    Type Description
    Int32

    Prompt

    The prompt to generate suggestions for at this depth.

    Declaration
    public string Prompt
    Field Value
    Type Description
    String

    Tags

    Any tags added to the suggestion context that may be queried by suggestors.

    Declaration
    public IQcSuggestorTag[] Tags
    Field Value
    Type Description
    IQcSuggestorTag[]

    TargetType

    If any, a specific type to target when producing suggestions.

    Declaration
    public Type TargetType
    Field Value
    Type Description
    Type

    Methods

    GetTag<T>()

    Gets the specified tag from the context.

    Declaration
    public T GetTag<T>()
    
        where T : IQcSuggestorTag
    Returns
    Type Description
    T

    The tag if it could be found, otherwise a KeyNotFoundException exception is thrown.

    Type Parameters
    Name Description
    T

    The tag to get from the context.

    GetTags<T>()

    Gets all instances of the specified tag from the context.

    Declaration
    public IEnumerable<T> GetTags<T>()
    
        where T : IQcSuggestorTag
    Returns
    Type Description
    IEnumerable<T>

    The tags in the context.

    Type Parameters
    Name Description
    T

    The tag to get from the context.

    HasTag<T>()

    Checks if the specified tag exists.

    Declaration
    public bool HasTag<T>()
    
        where T : IQcSuggestorTag
    Returns
    Type Description
    Boolean

    If the tag exists.

    Type Parameters
    Name Description
    T

    The tag to check.

    Extension Methods

    ArraySingleExtensions.AsArraySingle<T>(T)
    CollectionExtensions.Yield<T>(T)
    Quantum Console by QFSW
    Back to top