Struct SolidityHelper

pub struct SolidityHelper {
    errored: bool,
    do_paint: bool,
    sess: Session,
    globals: SessionGlobals,
}

A rustyline helper for Solidity code

Fields

errored: bool

do_paint: bool

sess: Session

globals: SessionGlobals

Implementations

impl SolidityHelper

pub fn new() -> Self

Create a new SolidityHelper.

pub fn errored(&self) -> bool

Returns whether the helper is in an errored state.

pub fn set_errored(&mut self, errored: bool) -> &mut Self

Set the errored field.

pub fn highlight<'a>(&self, input: &'a str) -> Cow<'a, str>

Highlights a Solidity source string.

fn with_contiguous_styles( &self, input: &str, f: impl FnMut(Style, Range<usize>), )

Returns a list of styles and the ranges they should be applied to.

Covers the entire source string, including any whitespace.

fn validate_closed(&self, input: &str) -> ValidationResult

Validate that a source snippet is closed (i.e., all braces and parenthesis are matched).

fn paint_unchecked(string: &str, style: Style, out: &mut String)

Formats input with style into out, without checking style.wrapping or self.do_paint.

fn paint_unchecked_owned(string: &str, style: Style) -> String

fn do_paint(&self) -> bool

Returns whether to color the output.

fn enter(&self, f: impl FnOnce(&Session))

Enters the session.

Trait Implementations

impl Completer for SolidityHelper

type Candidate = String

Specific completion candidate.

fn complete( &self, line: &str, pos: usize, ctx: &Context<'_>, ) -> Result<(usize, Vec<Self::Candidate>), ReadlineError>

Takes the currently edited line with the cursor position and returns the start position and the completion candidates for the partial word to be completed.

fn update( &self, line: &mut LineBuffer, start: usize, elected: &str, cl: &mut Changeset, )

Updates the edited line with the elected candidate.

impl Default for SolidityHelper

fn default() -> Self

Returns the “default value” for a type.

impl Highlighter for SolidityHelper

fn highlight<'l>(&self, line: &'l str, _pos: usize) -> Cow<'l, str>

Takes the currently edited line with the cursor position and returns the highlighted version (with ANSI color).

fn highlight_char(&self, line: &str, pos: usize, _kind: CmdKind) -> bool

Tells if line needs to be highlighted when a specific char is typed or when cursor is moved under a specific char.

fn highlight_prompt<'b, 's: 'b, 'p: 'b>( &'s self, prompt: &'p str, _default: bool, ) -> Cow<'b, str>

Takes the prompt and returns the highlighted version (with ANSI color).

fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>

Takes the hint and returns the highlighted version (with ANSI color).

fn highlight_candidate<'c>( &self, candidate: &'c str, completion: CompletionType, ) -> Cow<'c, str>

Takes the completion candidate and returns the highlighted version (with ANSI color).

impl Hinter for SolidityHelper

type Hint = String

Specific hint type

fn hint(&self, line: &str, pos: usize, ctx: &Context<'_>) -> Option<Self::Hint>

Takes the currently edited line with the cursor position and returns the string that should be displayed or None if no hint is available for the text the user currently typed.

impl Validator for SolidityHelper

fn validate(&self, ctx: &mut ValidationContext<'_>) -> Result<ValidationResult>

Takes the currently edited input and returns a ValidationResult indicating whether it is valid or not along with an option message to display about the result. The most common validity check to implement is probably whether the input is complete or not, for instance ensuring that all delimiters are fully balanced.

fn validate_while_typing(&self) -> bool

Configure whether validation is performed while typing or only when user presses the Enter key.

impl Helper for SolidityHelper

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 320 bytes