Class: Toys::Completion::Enum

Inherits:

Base

• Object
• Base
• Toys::Completion::Enum

Defined in:

core-docs/toys/completion.rb

Overview

Defined in the toys-core gem

A Completion whose candidates come from a static list of strings.

Instance Attribute Summary

• #prefix_constraint ⇒ String, Regexp readonly

  Constraint on the fragment prefix.

• #values ⇒ Array<String> readonly

  The array of completion candidates.

Instance Method Summary

• #call(context) ⇒ Array<Toys::Completion::Candidate>

  Returns candidates for the current completion.

• #initialize(values, prefix_constraint: "") ⇒ Enum constructor

  Create a completion from a list of values.

Constructor Details

#initialize(values, prefix_constraint: "") ⇒ Enum

Create a completion from a list of values.

Parameters:

• values (Array<String>)
• prefix_constraint (String, Regexp) (defaults to: "") —

  Constraint on the fragment prefix. Defaults to requiring the prefix be empty.

# File 'core-docs/toys/completion.rb', line 257

def initialize(values, prefix_constraint: "")
  # Source available in the toys-core gem
end

Instance Attribute Details

#prefix_constraint ⇒ String, Regexp (readonly)

Constraint on the fragment prefix.

Returns:

• (String, Regexp)

# File 'core-docs/toys/completion.rb', line 271

def prefix_constraint
  @prefix_constraint
end

#values ⇒ Array<String> (readonly)

The array of completion candidates.

Returns:

• (Array<String>)

# File 'core-docs/toys/completion.rb', line 265

def values
  @values
end

Instance Method Details

#call(context) ⇒ Array<Toys::Completion::Candidate>

Returns candidates for the current completion.

Parameters:

• context (Toys::Completion::Context) —

  the current completion context including the string fragment.

Returns:

• (Array<Toys::Completion::Candidate>) —

  an array of candidates

# File 'core-docs/toys/completion.rb', line 280

def call(context)
  # Source available in the toys-core gem
end