docindex

README

docindex

Package docindex fetches, parses, and lists text documents (with JSON metadata at the top of each file) in a directory tree.

Documentation on Sourcegraph

Installation

go get github.com/sourcegraph/docindex

Contributors

• Quinn Slack

Contributions are welcome! Submit a pull request on GitHub.

Documentation

Overview

Package docindex fetches and lists text documents (with metadata "front matter" at the top of each file) in a directory tree.

Index

• func IsNotFound(err error) bool
• type Index
  • func Open(dir string, metadataType interface{}) (*Index, error)
  • func (idx *Index) AllMetadata(metaMap interface{})
  • func (idx *Index) Doc(filename string, meta interface{}) ([]byte, error)
  • func (idx *Index) Filenames() []string
  • func (idx *Index) Reload() error

Functions

func IsNotFound

func IsNotFound(err error) bool

Types

type Index

type Index struct {
	// contains filtered or unexported fields
}

Index represents a directory containing text documents with metadata.

func Open

func Open(dir string, metadataType interface{}) (*Index, error)

Open reads all documents in dir and its subdirectories. Metadata JSON is decoded into structs whose type is pointer-to-metadataType.

If dir is not an existing directory, an error satisfying os.IsNotExist is returned.

func (*Index) AllMetadata

func (idx *Index) AllMetadata(metaMap interface{})

AllMetadata stores the metadata for each document in meta, which should be a map with string keys and values whose type is pointer-to-metadataType.

func (*Index) Doc

func (idx *Index) Doc(filename string, meta interface{}) ([]byte, error)

Doc returns the data in the document named by filename. If meta is a pointer a struct of the metadataType used in Open, the document metadata is written to that struct.

func (*Index) Filenames

func (idx *Index) Filenames() []string

Filenames returns a list of document filenames that were loaded in the last call to Open or Reload.

func (*Index) Reload

func (idx *Index) Reload() error

Reload refreshes the list of documents in the index.