filter

Documentation

Overview

Package filter implements the Elvish filter DSL.

The filter DSL is a subset of Elvish's expression syntax, and is useful for filtering a list of items. It is currently used in the listing modes of the interactive editor.

Index

• func Highlight(q string) (ui.Text, []error)
• type Filter
  • func Compile(q string) (Filter, error)

Functions

func Highlight

func Highlight(q string) (ui.Text, []error)

Types

type Filter

type Filter interface {
	Match(s string) bool
}

Filter represents a compiled filter, which can be used to match text.

func Compile

func Compile(q string) (Filter, error)

Compile parses and compiles a filter.