file

Documentation

Index

• type Client
  • func New(filepath string, opts ...Option) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) GetValues(keys []string) (map[string]string, error)
  • func (c *Client) WatchPrefix(ctx context.Context, prefix string, opts ...easykv.WatchOption) (uint64, error)
• type Option
  • func WithHeaders(headers map[string]string) Option
• type Options

Types

type Client

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

Client is a wrapper around the file client

func New

func New(filepath string, opts ...Option) (*Client, error)

New returns a new FileClient The filepath can be a local path to a file or a remote http/https location.

func (*Client) Close

func (c *Client) Close()

Close is only meant to fulfill the easykv.ReadWatcher interface. Does nothing.

func (*Client) GetValues

func (c *Client) GetValues(keys []string) (map[string]string, error)

GetValues returns all key-value pairs from the yaml or json file where the keys begins with one of the prefixes specified in the keys array.

func (*Client) WatchPrefix

func (c *Client) WatchPrefix(ctx context.Context, prefix string, opts ...easykv.WatchOption) (uint64, error)

WatchPrefix watches the file for changes with fsnotify. Prefix, keys and waitIndex are only here to implement the StoreClient interface. WatchPrefix is only supported for local files. Remote files over http/https arent supported. Remote filesystems like nfs are also not supported.

type Option

type Option func(*Options)

Option configures the file client.

func WithHeaders

func WithHeaders(headers map[string]string) Option

WithHeaders sets the headers for the HTTP request made when fetching remote files.

type Options

type Options struct {
	Headers map[string]string
}

Options contains all (possibly optional) values that are needed to fetch JSON or YAML files (either locally or remotely).