A11 (C++ runtime)
Native C++ implementation of the A11 streaming action runtime
Loading...
Searching...
No Matches
a11::flow::Proposal Struct Reference

One thing that may be written at an offset. More...

#include <cpp/a11/flow/complete.h>

Public Attributes

std::string name
 The word, as it would be read back: truncate, x.question.
 
ProposalKind kind = ProposalKind::kStatement
 
std::string insert
 Text inserted for this proposal, including required syntax.
 
std::string filter
 Text matched while the visible label includes an invocation verb.
 
int caret = -1
 Caret byte offset in insert; -1 places it at the end.
 
size_t replace_start = std::string::npos
 Optional document offset overriding the common prefix replacement.
 
std::string tail
 Grey text an editor shows after the name: what a stage takes, whether a port is required.
 
std::string type
 The type of the thing proposed, where it has one: a port's declared type.
 
std::string documentation
 Markdown documentation shared with hover results; empty when unavailable.
 

Detailed Description

One thing that may be written at an offset.

Member Data Documentation

◆ caret

int a11::flow::Proposal::caret = -1

Caret byte offset in insert; -1 places it at the end.

◆ documentation

std::string a11::flow::Proposal::documentation

Markdown documentation shared with hover results; empty when unavailable.

◆ filter

std::string a11::flow::Proposal::filter

Text matched while the visible label includes an invocation verb.

◆ insert

std::string a11::flow::Proposal::insert

Text inserted for this proposal, including required syntax.

◆ kind

ProposalKind a11::flow::Proposal::kind = ProposalKind::kStatement

◆ name

std::string a11::flow::Proposal::name

The word, as it would be read back: truncate, x.question.

◆ replace_start

size_t a11::flow::Proposal::replace_start = std::string::npos

Optional document offset overriding the common prefix replacement.

◆ tail

std::string a11::flow::Proposal::tail

Grey text an editor shows after the name: what a stage takes, whether a port is required.

Never part of what is inserted.

◆ type

std::string a11::flow::Proposal::type

The type of the thing proposed, where it has one: a port's declared type.


The documentation for this struct was generated from the following file: