v1

Documentation

Index

• func UnixClient(socket string) *http.Client
• type Client
• type ClientConfig
  • func NewClientConfig() *ClientConfig
  • func (c *ClientConfig) WithClient(client *http.Client) *ClientConfig
  • func (c *ClientConfig) WithManagerURL(u *url.URL) *ClientConfig
  • func (c *ClientConfig) WithManagerURLFromString(s string) (*ClientConfig, error)
• type HTTPClient
  • func NewHTTPClient(cfg *ClientConfig) HTTPClient
• type HTTPRootClient
  • func NewHTTPRootClient(cfg *ClientConfig) HTTPRootClient
• type RawHTTP
• type ReadOnlyClient
• type RootClient
• type Watcher

Functions

func UnixClient

func UnixClient(socket string) *http.Client

Types

type Client

type Client interface {
	ReadOnlyClient
	CreateDirectory(c context.Context, r *v1.CreateDirectoryRequest, parent v1.DirectoryID) (*v1.DirectoryFetch, error)
	UpdateDirectory(c context.Context, id v1.DirectoryID, r *v1.UpdateDirectoryRequest) (*v1.DirectoryFetch, error)
	DeleteDirectory(c context.Context, id v1.DirectoryID) (*v1.DirectoryList, error)
}

Client Allows for instantiating a client with read/write access to the API.

type ClientConfig

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

func NewClientConfig

func NewClientConfig() *ClientConfig

func (*ClientConfig) WithClient

func (c *ClientConfig) WithClient(client *http.Client) *ClientConfig

func (*ClientConfig) WithManagerURL

func (c *ClientConfig) WithManagerURL(u *url.URL) *ClientConfig

func (*ClientConfig) WithManagerURLFromString

func (c *ClientConfig) WithManagerURLFromString(s string) (*ClientConfig, error)

type HTTPClient

type HTTPClient interface {
	Client
	RawHTTP
}

HTTPClient allows for instantiating a client that can do general HTTP requests.

func NewHTTPClient

func NewHTTPClient(cfg *ClientConfig) HTTPClient

type HTTPRootClient

type HTTPRootClient interface {
	RootClient
	RawHTTP
}

func NewHTTPRootClient

func NewHTTPRootClient(cfg *ClientConfig) HTTPRootClient

type RawHTTP

type RawHTTP interface {
	DoRaw(c context.Context, method, path string, data io.Reader) (*http.Response, error)
}

RawHTTP allows for instantiating a client with raw HTTP access to the API.

type ReadOnlyClient

type ReadOnlyClient interface {
	GetDirectory(c context.Context, id v1.DirectoryID, options ...storage.Option) (*v1.DirectoryFetch, error)
	GetParents(c context.Context, id v1.DirectoryID, options ...storage.Option) (*v1.DirectoryList, error)
	GetParentsUntil(c context.Context, id, until v1.DirectoryID, options ...storage.Option) (*v1.DirectoryList, error)
	GetChildren(c context.Context, id v1.DirectoryID, options ...storage.Option) (*v1.DirectoryList, error)
}

ReadOnlyClient allows for instantiating a client with read-only access to the API.

type RootClient

type RootClient interface {
	Client // Embed the Client interface
	CreateRoot(c context.Context, r *v1.CreateDirectoryRequest) (*v1.DirectoryFetch, error)
	ListRoots(c context.Context, options ...storage.Option) (*v1.DirectoryList, error)
}

RootClient allows for instantiating a client with read/write and root node access to the API.

type Watcher

type Watcher interface {
	// Watch starts watching for events.
	// It returns a channel for events and a channel for errors.
	Watch(ctx context.Context) (<-chan *v1.DirectoryEvent, <-chan error)
}