dl

package

v0.1.0 Latest Latest Go to latest Published: Dec 5, 2020 License: MIT Imports: 15 Imported by: 0

Details

Package dl implements documentation downloading facility.

View Source

const NoLayer = 0

NoLayer can be passed as "layer" argument.

View Source

var ErrReadOnly = errors.New("write operation in read only mode")

func NewZipFS(p string) (vfs.FS, error)

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

func NewClient(opt Options) (*Client, error)

func (c *Client) Close() error

func (c *Client) Get(ctx context.Context, layer int, key string) ([]byte, error)

Get fetches documentation by key and layer.

Pass "NoLayer" as layer to use default documentation. Examples for "key" value:

Blank key is invalid.

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Options struct {
	Path     string
	FS       vfs.FS
	Client   HTTPClient
	Readonly bool
}