matching

Documentation

Overview

Package matching provides matching features that find appropriate strings by using a passed input string.

Index

• type Matched
  • func FindAll(in string, slice []string) []Matched
• type Mode
• type Option
  • func WithMode(m Mode) Option

Types

type Matched

type Matched struct {
	// Idx is the index of an item of the original slice which was used to
	// search matched strings.
	Idx int
	// Pos is the range of matched position.
	// [2]int represents an open interval of a position.
	Pos [2]int
	// contains filtered or unexported fields
}

Matched represents a result of FindAll.

func FindAll

func FindAll(in string, slice []string) []Matched

FindAll tries to find out sub-strings from slice that match the passed argument in. The returned slice is sorted by similarity scores in descending order.

type Mode

type Mode int

const (
	ModeSmart Mode = iota
	ModeCaseSensitive
	ModeCaseInsensitive
)

type Option

type Option func(*opt)

Option represents available matching options.

func WithMode

func WithMode(m Mode) Option

WithMode specifies a matching mode. The default mode is ModeSmart.