edgedict

Documentation

Overview

Package edgedict provides a read-only interface to edge dictionaries. Refer to https://developer.fastly.com/reference/api/dictionaries/ for more information.

Deprecated: Use the configstore package instead.

Index

• Variables
• type Dictionary
  • func Open(name string) (*Dictionary, error)
  • func (d *Dictionary) Get(key string) (string, error)
  • func (d *Dictionary) GetBytes(key string) ([]byte, error)
  • func (d *Dictionary) Has(key string) (bool, error)

Variables

var (
	// ErrDictionaryNotFound indicates the named dictionary doesn't exist.
	ErrDictionaryNotFound = errors.New("dictionary not found")

	// ErrDictionaryNameEmpty indicates the given dictionary name
	// was empty.
	ErrDictionaryNameEmpty = errors.New("dictionary name was empty")

	// ErrDictionaryNameInvalid indicates the given dictionary name
	// was invalid.
	ErrDictionaryNameInvalid = errors.New("dictionary name contained invalid characters")

	// ErrDictionaryNameTooLong indicates the given dictionary name
	// was too long.
	ErrDictionaryNameTooLong = errors.New("dictionary name too long")

	// ErrKeyNotFound indicates a key isn't in a dictionary.
	ErrKeyNotFound = errors.New("key not found")

	// ErrUnexpected indicates an unexpected error occurred.
	ErrUnexpected = errors.New("unexpected error")
)

Types

type Dictionary

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

Dictionary is a read-only representation of an edge dictionary.

Deprecated: Use the configstore package instead.

func Open

func Open(name string) (*Dictionary, error)

Open returns an edge dictionary with the given name. Names are case sensitive.

Deprecated: Use configstore.Open() instead.

func (*Dictionary) Get

func (d *Dictionary) Get(key string) (string, error)

Get returns the value in the dictionary with the given key, if it exists.

func (*Dictionary) GetBytes

func (d *Dictionary) GetBytes(key string) ([]byte, error)

GetBytes returns the value in the dictionary for the given key, if it exists, as a byte slice.

func (*Dictionary) Has

func (d *Dictionary) Has(key string) (bool, error)

Has returns true if the key exists in the dictionary, without allocating space to read a value.