class TermUtils::FF::Config

Represents a query configuration.

Attributes

ignore_list[RW]

@return [Array<Regexp>]

max_depth[RW]

@return [Integer, nil]

min_depth[RW]

@return [Integer, nil]

sorting_compare[RW]

@return [Proc, nil]

sorting_mode[RW]

@return [Symbol, nil] Either `:forward`, `:reverse` or `nil` (default).

Public Class Methods

new() click to toggle source

Constructs a new Config.

# File lib/term_utils/ff/config.rb, line 35
def initialize
  @ignore_list = []
  @min_depth = nil
  @max_depth = nil
  @sorting_mode = nil
  @sorting_compare = nil
end

Public Instance Methods

initialize_copy(other) click to toggle source
Calls superclass method
# File lib/term_utils/ff/config.rb, line 49
def initialize_copy(other)
  @ignore_list = other.ignore_list.dup
  super
end
sorted?() click to toggle source

Returns whether the search is ordered. @return [Boolean]

# File lib/term_utils/ff/config.rb, line 45
def sorted?
  (@sorting_mode == :forward) || (@sorting_mode == :reverse)
end