search

Documentation

Overview

Package search provides protocol documentation search engine.

Index

• func FormatResults(results []SearchResult) string
• type Document
• type Index
  • func NewIndex() *Index
  • func (idx *Index) Add(doc Document)
  • func (idx *Index) Search(query string) []SearchResult
• type SearchResult

Functions

func FormatResults

func FormatResults(results []SearchResult) string

FormatResults formats search results.

Types

type Document

type Document struct {
	Protocol string            `json:"protocol"`
	Fields   map[string]string `json:"fields"`
	Layer    string            `json:"layer"`
	Tags     []string          `json:"tags"`
}

Document represents a searchable protocol document.

type Index

type Index struct {
	Docs []Document
}

Index holds the search index.

func NewIndex

func NewIndex() *Index

NewIndex creates a new search index.

func (*Index) Add

func (idx *Index) Add(doc Document)

Add adds a document to the index.

func (*Index) Search

func (idx *Index) Search(query string) []SearchResult

Search performs a full-text search.

type SearchResult

type SearchResult struct {
	Protocol string  `json:"protocol"`
	Score    float64 `json:"score"`
	Match    string  `json:"match"`
}

SearchResult represents a search result.