fs

Documentation

Overview

Package fs implements a key-value store that stores keys as file names and values as file content.

Index

• type Conn
  • func NewConn(dir string) (*Conn, error)
  • func (c *Conn) Create(_ context.Context, name string, value []byte) error
  • func (c *Conn) Delete(_ context.Context, name string) error
  • func (c *Conn) Get(_ context.Context, name string) ([]byte, error)
  • func (c *Conn) List(ctx context.Context) (kms.Iter, error)
  • func (c *Conn) Status(context.Context) (kms.State, error)
• type Iter
  • func NewIter(ctx context.Context, dir fs.ReadDirFile) *Iter
  • func (i *Iter) Close() error
  • func (i *Iter) Name() string
  • func (i *Iter) Next() bool

Types

type Conn

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

Conn is a connection to a directory on the filesystem.

It implements the kms.Conn interface and acts as KMS abstraction over a fileystem.

func NewConn

func NewConn(dir string) (*Conn, error)

NewConn returns a new Conn that reads from and writes to the given directory.

If the directory or any parent directory does not exist, NewConn creates them all.

It returns an error if dir exists but is not a directory.

func (*Conn) Create

func (c *Conn) Create(_ context.Context, name string, value []byte) error

Create creates a new file with the given name inside the Conn directory if and only if no such file exists.

It returns kes.ErrKeyExists if such a file already exists.

func (*Conn) Delete

func (c *Conn) Delete(_ context.Context, name string) error

Delete deletes the named file within the Conn directory if and only if it exists. It returns kes.ErrKeyNotFound if no such file exists.

func (*Conn) Get

func (c *Conn) Get(_ context.Context, name string) ([]byte, error)

Get reads the content of the named file within the Conn directory. It returns kes.ErrKeyNotFound if no such file exists.

func (*Conn) List

func (c *Conn) List(ctx context.Context) (kms.Iter, error)

List returns a Iter over the files within the Conn directory. The Iter must be closed to release any filesystem resources back to the OS.

func (*Conn) Status

func (c *Conn) Status(context.Context) (kms.State, error)

Status returns the current state of the Conn.

In particular, it reports whether the underlying filesystem is accessible.

type Iter

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

Iter is an iterator over all files within a directory. It must be closed to release any filesystem resources.

func NewIter

func NewIter(ctx context.Context, dir fs.ReadDirFile) *Iter

NewIter returns an Iter all files within the given directory. The Iter does not iterator recursively into subdirectories.

func (*Iter) Close

func (i *Iter) Close() error

Close closes the Iter and releases and filesystem resources back to the OS.

func (*Iter) Name

func (i *Iter) Name() string

Name returns the current name of the directory entry. It returns the empty string if there are no more entries or once the Iter has encountered an error.

func (*Iter) Next

func (i *Iter) Next() bool

Next reports whether there are more directory entries. It returns false when there are no more entries, the Iter got closed or once it encounters an error.

The name of the next directory entry is availbale via the Name method.