package truncindex

import "github.com/docker/cli/components/engine/pkg/truncindex"

Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id.

Index ¶

• Variables
• type ErrAmbiguousPrefix
• func (e ErrAmbiguousPrefix) Error() string
• type TruncIndex
• func NewTruncIndex(ids []string) (idx *TruncIndex)
• func (idx *TruncIndex) Add(id string) error
• func (idx *TruncIndex) Delete(id string) error
• func (idx *TruncIndex) Get(s string) (string, error)
• func (idx *TruncIndex) Iterate(handler func(id string))

Variables ¶

var (
	// ErrEmptyPrefix is an error returned if the prefix was empty.
	ErrEmptyPrefix = errors.New("Prefix can't be empty")

	// ErrIllegalChar is returned when a space is in the ID
	ErrIllegalChar = errors.New("illegal character: ' '")

	// ErrNotExist is returned when ID or its prefix not found in index.
	ErrNotExist = errors.New("ID does not exist")
)

Types ¶

type ErrAmbiguousPrefix ¶

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

ErrAmbiguousPrefix is returned if the prefix was ambiguous (multiple ids for the prefix).

func (ErrAmbiguousPrefix) Error ¶

func (e ErrAmbiguousPrefix) Error() string

type TruncIndex ¶

type TruncIndex struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

TruncIndex allows the retrieval of string identifiers by any of their unique prefixes. This is used to retrieve image and container IDs by more convenient shorthand prefixes.

func NewTruncIndex ¶

func NewTruncIndex(ids []string) (idx *TruncIndex)

NewTruncIndex creates a new TruncIndex and initializes with a list of IDs.

func (*TruncIndex) Add ¶

func (idx *TruncIndex) Add(id string) error

Add adds a new ID to the TruncIndex.

func (*TruncIndex) Delete ¶

func (idx *TruncIndex) Delete(id string) error

Delete removes an ID from the TruncIndex. If there are multiple IDs with the given prefix, an error is thrown.

func (*TruncIndex) Get ¶

func (idx *TruncIndex) Get(s string) (string, error)

Get retrieves an ID from the TruncIndex. If there are multiple IDs with the given prefix, an error is thrown.

func (*TruncIndex) Iterate ¶

func (idx *TruncIndex) Iterate(handler func(id string))

Iterate iterates over all stored IDs and passes each of them to the given handler. Take care that the handler method does not call any public method on truncindex as the internal locking is not reentrant/recursive and will result in deadlock.

Source Files ¶

truncindex.go