webdav

README

go-webdav

A Go library for WebDAV, CalDAV and CardDAV.

License

MIT

Documentation

Overview

Package webdav provides a client and server WebDAV filesystem implementation.

WebDAV is defined in RFC 4918.

Index

• type Client
  • func NewClient(c HTTPClient, endpoint string) (*Client, error)
  • func (c *Client) CopyAll(name, dest string, overwrite bool) error
  • func (c *Client) Create(name string) (io.WriteCloser, error)
  • func (c *Client) FindCurrentUserPrincipal() (string, error)
  • func (c *Client) Mkdir(name string) error
  • func (c *Client) MoveAll(name, dest string, overwrite bool) error
  • func (c *Client) Open(name string) (io.ReadCloser, error)
  • func (c *Client) Readdir(name string, recursive bool) ([]FileInfo, error)
  • func (c *Client) RemoveAll(name string) error
  • func (c *Client) Stat(name string) (*FileInfo, error)
• type FileInfo
• type FileSystem
• type HTTPClient
  • func HTTPClientWithBasicAuth(c HTTPClient, username, password string) HTTPClient
• type Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type LocalFileSystem
  • func (fs LocalFileSystem) Copy(src, dst string, recursive, overwrite bool) (created bool, err error)
  • func (fs LocalFileSystem) Create(name string) (io.WriteCloser, error)
  • func (fs LocalFileSystem) Mkdir(name string) error
  • func (fs LocalFileSystem) MoveAll(src, dst string, overwrite bool) (created bool, err error)
  • func (fs LocalFileSystem) Open(name string) (io.ReadCloser, error)
  • func (fs LocalFileSystem) Readdir(name string, recursive bool) ([]FileInfo, error)
  • func (fs LocalFileSystem) RemoveAll(name string) error
  • func (fs LocalFileSystem) Stat(name string) (*FileInfo, error)

Types

type Client

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

Client provides access to a remote WebDAV filesystem.

func NewClient

func NewClient(c HTTPClient, endpoint string) (*Client, error)

func (*Client) CopyAll

func (c *Client) CopyAll(name, dest string, overwrite bool) error

func (*Client) Create

func (c *Client) Create(name string) (io.WriteCloser, error)

func (*Client) FindCurrentUserPrincipal

func (c *Client) FindCurrentUserPrincipal() (string, error)

func (*Client) Mkdir

func (c *Client) Mkdir(name string) error

func (*Client) MoveAll

func (c *Client) MoveAll(name, dest string, overwrite bool) error

func (*Client) Open

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

func (*Client) Readdir

func (c *Client) Readdir(name string, recursive bool) ([]FileInfo, error)

func (*Client) RemoveAll

func (c *Client) RemoveAll(name string) error

func (*Client) Stat

func (c *Client) Stat(name string) (*FileInfo, error)

type FileInfo

type FileInfo struct {
	Path     string
	Size     int64
	ModTime  time.Time
	IsDir    bool
	MIMEType string
	ETag     string
}

type FileSystem

type FileSystem interface {
	Open(name string) (io.ReadCloser, error)
	Stat(name string) (*FileInfo, error)
	Readdir(name string, recursive bool) ([]FileInfo, error)
	Create(name string) (io.WriteCloser, error)
	RemoveAll(name string) error
	Mkdir(name string) error
	Copy(name, dest string, recursive, overwrite bool) (created bool, err error)
	MoveAll(name, dest string, overwrite bool) (created bool, err error)
}

FileSystem is a WebDAV server backend.

type HTTPClient

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

HTTPClient performs HTTP requests. It's implemented by *http.Client.

func HTTPClientWithBasicAuth

func HTTPClientWithBasicAuth(c HTTPClient, username, password string) HTTPClient

HTTPClientWithBasicAuth returns an HTTP client that adds basic authentication to all outgoing requests. If c is nil, http.DefaultClient is used.

type Handler

type Handler struct {
	FileSystem FileSystem
}

Handler handles WebDAV HTTP requests. It can be used to create a WebDAV server.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.

type LocalFileSystem

type LocalFileSystem string

func (LocalFileSystem) Copy

func (fs LocalFileSystem) Copy(src, dst string, recursive, overwrite bool) (created bool, err error)

func (LocalFileSystem) Create

func (fs LocalFileSystem) Create(name string) (io.WriteCloser, error)

func (LocalFileSystem) Mkdir

func (fs LocalFileSystem) Mkdir(name string) error

func (LocalFileSystem) MoveAll

func (fs LocalFileSystem) MoveAll(src, dst string, overwrite bool) (created bool, err error)

func (LocalFileSystem) Open

func (fs LocalFileSystem) Open(name string) (io.ReadCloser, error)

func (LocalFileSystem) Readdir

func (fs LocalFileSystem) Readdir(name string, recursive bool) ([]FileInfo, error)

func (LocalFileSystem) RemoveAll

func (fs LocalFileSystem) RemoveAll(name string) error

func (LocalFileSystem) Stat

func (fs LocalFileSystem) Stat(name string) (*FileInfo, error)