openuri

README

openuri

This is a library that enables opening files and urls transparently.

It supports:

• Direct file access (no protocol)
• file:// protocol
• http:// and https:// trought net/http
• data: uri
• Custom protocols

Usage

f, err := openuri.Open(fn)
if err != nil {
	return err
}
defer f.Close()
...

Documentation

Index

• Variables
• func Open(fn string) (io.ReadCloser, error)
• func OpenContext(ctx context.Context, fn string) (io.ReadCloser, error)
• func OpenURL(u *url.URL) (io.ReadCloser, error)
• func OpenURLContext(ctx context.Context, u *url.URL) (io.ReadCloser, error)
• func Stat(fn string) (fs.FileInfo, error)
• func StatContext(ctx context.Context, fn string) (fs.FileInfo, error)
• func StatURL(u *url.URL) (fs.FileInfo, error)
• func StatURLContext(ctx context.Context, u *url.URL) (fs.FileInfo, error)
• type Client
  • func (c *Client) Open(fn string) (io.ReadCloser, error)
  • func (c *Client) OpenContext(ctx context.Context, fn string) (io.ReadCloser, error)
  • func (c *Client) OpenURL(u *url.URL) (io.ReadCloser, error)
  • func (c *Client) OpenURLContext(ctx context.Context, u *url.URL) (io.ReadCloser, error)
  • func (c *Client) Stat(fn string) (fs.FileInfo, error)
  • func (c *Client) StatContext(ctx context.Context, fn string) (fs.FileInfo, error)
  • func (c *Client) StatURL(u *url.URL) (fs.FileInfo, error)
  • func (c *Client) StatURLContext(ctx context.Context, u *url.URL) (fs.FileInfo, error)
• type Handler
• type HttpProtocol
  • func (h *HttpProtocol) OpenURI(ctx context.Context, c *Client, u *url.URL) (io.ReadCloser, error)
  • func (h *HttpProtocol) StatURI(ctx context.Context, c *Client, u *url.URL) (fs.FileInfo, error)

Variables

var (
	DefaultClient = &Client{}
	AllowLocal    = &Client{AllowLocal: true}
)

var (
	ErrNotAbsolute          = errors.New("Provided URL is not absolute")
	ErrProtocolNotSupported = errors.New("requested protocol is not supported")
	ErrLocalInvalidHost     = errors.New("invalid file: hostname provided")
)

var Data = &dataProtocol{}

var Http = &HttpProtocol{Client: http.DefaultClient}

var Local = &localProtocol{}

var Protocols = map[string]Handler{
	"file":  Local,
	"http":  Http,
	"https": Http,
	"data":  Data,
}

Functions

func Open

func Open(fn string) (io.ReadCloser, error)

default handlers

func OpenContext

func OpenContext(ctx context.Context, fn string) (io.ReadCloser, error)

func OpenURL

func OpenURL(u *url.URL) (io.ReadCloser, error)

func OpenURLContext

func OpenURLContext(ctx context.Context, u *url.URL) (io.ReadCloser, error)

func Stat

func Stat(fn string) (fs.FileInfo, error)

func StatContext

func StatContext(ctx context.Context, fn string) (fs.FileInfo, error)

func StatURL

func StatURL(u *url.URL) (fs.FileInfo, error)

func StatURLContext

func StatURLContext(ctx context.Context, u *url.URL) (fs.FileInfo, error)

Types

type Client

type Client struct {
	AllowLocal bool // if false, file:// and local access will be disabled. If true, even removing the file:// protocol will still allow direct file opening
}

func (*Client) Open

func (c *Client) Open(fn string) (io.ReadCloser, error)

func (*Client) OpenContext

func (c *Client) OpenContext(ctx context.Context, fn string) (io.ReadCloser, error)

func (*Client) OpenURL

func (c *Client) OpenURL(u *url.URL) (io.ReadCloser, error)

func (*Client) OpenURLContext

func (c *Client) OpenURLContext(ctx context.Context, u *url.URL) (io.ReadCloser, error)

func (*Client) Stat

func (c *Client) Stat(fn string) (fs.FileInfo, error)

func (*Client) StatContext

func (c *Client) StatContext(ctx context.Context, fn string) (fs.FileInfo, error)

func (*Client) StatURL

func (c *Client) StatURL(u *url.URL) (fs.FileInfo, error)

func (*Client) StatURLContext

func (c *Client) StatURLContext(ctx context.Context, u *url.URL) (fs.FileInfo, error)

type Handler

type Handler interface {
	OpenURI(ctx context.Context, c *Client, u *url.URL) (io.ReadCloser, error)
	StatURI(ctx context.Context, c *Client, u *url.URL) (fs.FileInfo, error)
}

type HttpProtocol

type HttpProtocol struct {
	Client *http.Client
}

func (*HttpProtocol) OpenURI

func (h *HttpProtocol) OpenURI(ctx context.Context, c *Client, u *url.URL) (io.ReadCloser, error)

func (*HttpProtocol) StatURI

func (h *HttpProtocol) StatURI(ctx context.Context, c *Client, u *url.URL) (fs.FileInfo, error)