files

Documentation

Overview

Package files declares the FileStore interface and implements a single in-memory FileStore

Index

• Variables
• type FileStore
• type InMemoryStore
  • func InMemory() InMemoryStore
  • func (s InMemoryStore) AddData(files ...*apb.FileData) error
  • func (s InMemoryStore) ClearData()
  • func (s InMemoryStore) FileData(path, digest string) ([]byte, error)

Variables

var ErrNotFound = errors.New("file data not found")

ErrNotFound is an error indicating that a requested file's data could not be found in a FileStore.

Types

type FileStore

type FileStore interface {
	// FileData returns the data for the file described by the given path and
	// digest. Returns a NotFound error if the file data could not be found.
	FileData(path, digest string) ([]byte, error)
}

FileStore refers to an open Kythe file storage server.

type InMemoryStore

type InMemoryStore map[string][]byte

InMemoryStore is a FileStore that serves files based on an in-memory map from digest to file contents.

func InMemory

func InMemory() InMemoryStore

InMemory returns an empty InMemoryStore

func (InMemoryStore) AddData

func (s InMemoryStore) AddData(files ...*apb.FileData) error

AddData adds each FileData to the InMemoryStore based on their digests.

func (InMemoryStore) ClearData

func (s InMemoryStore) ClearData()

ClearData removes all file data contained within the InMemoryStore.

func (InMemoryStore) FileData

func (s InMemoryStore) FileData(path, digest string) ([]byte, error)

FileData implements a FileStore for an InMemoryStore.