GoWebDAV

https://pkg.go.dev/github.com/studio-b12/gowebdav@latest
Admin
GoWebDAV is a pure Go WebDAV client library that enables developers to interact with remote WebDAV...
Tokens:25,297
Snippets:284
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get File/Folder Information

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Retrieve metadata for a specified file or folder on the WebDAV server. The returned value implements os.FileInfo.

```go
webdavFilePath := "folder/subfolder/file.txt"

info := c.Stat(webdavFilePath)
//notice that [info] has os.FileInfo type
fmt.Println(info)

```

--------------------------------

### Get File Information

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Stat retrieves the os.FileInfo for a specified remote path, providing details like file size, modification time, and whether it's a directory.

```go
func (c *Client) Stat(path string) (os.FileInfo, error)
```

--------------------------------

### FixSlashes Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Ensures a string starts and ends with a slash.

```go
func FixSlashes(s string) string

```

--------------------------------

### Client Connect Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Establishes a connection to the WebDAV server.

```go
func (c *Client) Connect() error

```

--------------------------------

### Client Mkdir Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a new directory at the specified path.

```go
func (c *Client) Mkdir(path string, _ os.FileMode) (err error)

```

--------------------------------

### Client MkdirAll Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a directory and any necessary parent directories.

```go
func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)

```

--------------------------------

### Initialize New WebDAV Client

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Create a new client instance for a WebDAV server. Ensure to handle errors in production code.

```go
root := "https://webdav.mydomain.me"
user := "user"
password := "password"

c := gowebdav.NewClient(root, user, password)
c.Connect()
// kick of your work!

```

--------------------------------

### Escape path segments

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

PathEscape encodes all segments of a given path, ensuring it is safe for use in URLs. The example shows various path formats and their escaped outputs.

```go
func PathEscape(path string) string
```

```text
Output:

/
/web
/web/
/w%20e%20b/d%20a%20v/s%25u&c%23k:s/

```

--------------------------------

### File Sys Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the underlying file system data.

```go
func (f File) Sys() interface{}

```

--------------------------------

### Client Copy Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Copies a file or directory from one path to another.

```go
func (c *Client) Copy(oldpath, newpath string, overwrite bool) error

```

--------------------------------

### NewClient Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a new WebDAV client with basic username and password authentication.

```go
func NewClient(uri, user, pw string) *Client

```

--------------------------------

### Client.Mkdir

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a directory at the specified path.

```APIDOC
###### func (*Client) Mkdir

### Description
Mkdir makes a directory

### Signature
```go
func (c *Client) Mkdir(path string, _ os.FileMode) (err error)
```
```

--------------------------------

### Client Initialization

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Provides methods for creating a new WebDAV client with different authentication strategies.

```APIDOC
## NewAuthClient

### Description
Creates a new WebDAV client with a specified authorizer.

### Signature
`func NewAuthClient(uri string, auth Authorizer) *Client`

### Parameters
- `uri` (string): The base URI of the WebDAV server.
- `auth` (Authorizer): An object implementing the Authorizer interface for authentication.

### Returns
- `*Client`: A pointer to the initialized WebDAV client.
```

```APIDOC
## NewClient

### Description
Creates a new WebDAV client with basic username and password authentication.

### Signature
`func NewClient(uri, user, pw string) *Client`

### Parameters
- `uri` (string): The base URI of the WebDAV server.
- `user` (string): The username for authentication.
- `pw` (string): The password for authentication.

### Returns
- `*Client`: A pointer to the initialized WebDAV client.
```

--------------------------------

### File Mode Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the file mode.

```go
func (f File) Mode() os.FileMode

```

--------------------------------

### File String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the file.

```go
func (f File) String() string

```

--------------------------------

### Create WebDAV Client with Username and Password

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

NewClient provides a convenient way to create a WebDAV client instance using a URI, username, and password.

```go
func NewClient(uri, user, pw string) *Client
```

--------------------------------

### File Size Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the size of the file.

```go
func (f File) Size() int64

```

--------------------------------

### File Name Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the name of the file.

```go
func (f File) Name() string

```

--------------------------------

### Create WebDAV Client with Custom Authorizer

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Use NewAuthClient to initialize a WebDAV client with a specific Authorizer implementation.

```go
func NewAuthClient(uri string, auth Authorizer) *Client
```

--------------------------------

### File Path Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the path of the file.

```go
func (f File) Path() string

```

--------------------------------

### Client Stat Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Retrieves file information for a given path.

```go
func (c *Client) Stat(path string) (os.FileInfo, error)

```

--------------------------------

### Connect to WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The Connect method establishes a connection to the configured WebDAV server.

```go
func (c *Client) Connect() error
```

--------------------------------

### Client Read Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads the entire content of a file into a byte slice.

```go
func (c *Client) Read(path string) ([]byte, error)

```

--------------------------------

### Client Write Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Writes byte data to a file.

```go
func (c *Client) Write(path string, data []byte, _ os.FileMode) (err error)

```

--------------------------------

### File Path Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the full path of the file on the WebDAV server. Includes the directory structure.

```go
func (f File) Path() string


```

--------------------------------

### Client ReadStream Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Opens a file for reading as a stream.

```go
func (c *Client) ReadStream(path string) (io.ReadCloser, error)

```

--------------------------------

### BasicAuth String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the BasicAuth authenticator.

```go
func (b *BasicAuth) String() string

```

--------------------------------

### File Name Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the name of the file. This is the base name without the directory path.

```go
func (f File) Name() string


```

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a new instance of the WebDAV client with basic authentication.

```APIDOC
###### func NewClient

### Description
NewClient creates a new instance of client

### Signature
```go
func NewClient(uri, user, pw string) *Client
```
```

--------------------------------

### Create Directory on WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Create a new directory on the WebDAV server. The permission bits are similar to os.Mkdir.

```go
err := c.Mkdir("folder", 0644)

```

--------------------------------

### BasicAuth Verify Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Verifies the authentication response.

```go
func (b *BasicAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)

```

--------------------------------

### Client.MkdirAll

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a directory and its parents if they do not exist, similar to `mkdir -p`.

```APIDOC
###### func (*Client) MkdirAll

### Description
MkdirAll like mkdir -p, but for webdav

### Signature
```go
func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)
```
```

--------------------------------

### File Size Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the size of the file in bytes. Useful for estimating download or upload times.

```go
func (f File) Size() int64


```

--------------------------------

### BasicAuth Authorize Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Authorizes a request using Basic Authentication.

```go
func (b *BasicAuth) Authorize(c *http.Client, rq *http.Request, path string) error

```

--------------------------------

### File Mode Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the file mode (permissions) of the file. Indicates read, write, and execute permissions.

```go
func (f File) Mode() os.FileMode


```

--------------------------------

### Client.Connect

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Connects to the WebDAV server.

```APIDOC
###### func (*Client) Connect

### Description
Connect connects to our dav server

### Signature
```go
func (c *Client) Connect() error
```
```

--------------------------------

### Client ReadDir Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads the contents of a directory, returning file information.

```go
func (c *Client) ReadDir(path string) ([]os.FileInfo, error)

```

--------------------------------

### File Sys Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the underlying system-specific information for the file. The exact type and content depend on the operating system and WebDAV server.

```go
func (f File) Sys() interface{}


```

--------------------------------

### BasicAuth Clone Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a clone of the BasicAuth authenticator.

```go
func (b *BasicAuth) Clone() Authenticator

```

--------------------------------

### Client Rename Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Renames a file or directory.

```go
func (c *Client) Rename(oldpath, newpath string, overwrite bool) error

```

--------------------------------

### Client SetJar Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Sets a cookie jar for managing cookies.

```go
func (c *Client) SetJar(jar http.CookieJar)

```

--------------------------------

### Join Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Joins two path segments, ensuring correct slash separation.

```go
func Join(path0 string, path1 string) string

```

--------------------------------

### File String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Provides a string representation of the File object, summarizing its information. Useful for logging or debugging.

```go
func (f File) String() string


```

--------------------------------

### File ETag Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the ETag of the file.

```go
func (f File) ETag() string

```

--------------------------------

### Create Nested Directories on WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Create multiple nested directories on the WebDAV server. Similar to os.MkdirAll.

```go
err := c.MkdirAll("folder/subfolder/subfolder2", 0644)

```

--------------------------------

### Create Directory on WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The Mkdir method creates a single directory at the specified path. The os.FileMode parameter is accepted but may not be fully utilized by all WebDAV servers.

```go
func (c *Client) Mkdir(path string, _ os.FileMode) (err error)
```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Provides methods for common WebDAV operations like connecting, copying, creating directories, reading, removing, renaming, and writing files.

```APIDOC
## Client Methods

### Connect

Establishes a connection to the WebDAV server.

### Method

```
func (c *Client) Connect() error
```

### Copy

Copies a file or directory from one path to another.

### Method

```
func (c *Client) Copy(oldpath, newpath string, overwrite bool) error
```

### Mkdir

Creates a new directory at the specified path.

### Method

```
func (c *Client) Mkdir(path string, _ os.FileMode) error
```

### MkdirAll

Creates a directory and any necessary parent directories at the specified path.

### Method

```
func (c *Client) MkdirAll(path string, _ os.FileMode) error
```

### Read

Reads the entire content of a file at the specified path.

### Method

```
func (c *Client) Read(path string) ([]byte, error)
```

### ReadDir

Reads the contents of a directory at the specified path.

### Method

```
func (c *Client) ReadDir(path string) ([]os.FileInfo, error)
```

### ReadStream

Opens a stream to read the content of a file at the specified path.

### Method

```
func (c *Client) ReadStream(path string) io.ReadCloser
```

### ReadStreamRange

Opens a stream to read a specific range of bytes from a file at the specified path.

### Method

```
func (c *Client) ReadStreamRange(path string, offset, length int64) io.ReadCloser
```

### Remove

Removes a file or directory at the specified path.

### Method

```
func (c *Client) Remove(path string) error
```

### RemoveAll

Removes a file or directory and any contents at the specified path.

### Method

```
func (c *Client) RemoveAll(path string) error
```

### Rename

Renames a file or directory from one path to another.

### Method

```
func (c *Client) Rename(oldpath, newpath string, overwrite bool) error
```

### SetHeader

Sets a custom header for all subsequent requests.

### Method

```
func (c *Client) SetHeader(key, value string)
```

### SetInterceptor

Sets a function to intercept and modify outgoing requests.

### Method

```
func (c *Client) SetInterceptor(interceptor func(method string, rq *http.Request))
```

### SetJar

Sets a cookie jar for managing cookies across requests.

### Method

```
func (c *Client) SetJar(jar http.CookieJar)
```

### SetTimeout

Sets the timeout for all HTTP requests.

### Method

```
func (c *Client) SetTimeout(timeout time.Duration)
```

### SetTransport

Sets a custom HTTP transport for making requests.

### Method

```
func (c *Client) SetTransport(transport http.RoundTripper)
```

### Stat

Retrieves file information for a given path.

### Method

```
func (c *Client) Stat(path string) (os.FileInfo, error)
```

### Write

Writes data to a file at the specified path.

### Method

```
func (c *Client) Write(path string, data []byte, _ os.FileMode) error
```

### WriteStream

Writes data from a stream to a file at the specified path.

### Method

```
func (c *Client) WriteStream(path string, stream io.Reader, _ os.FileMode) error
```

### WriteStreamWithLength

Writes data from a stream to a file at the specified path, providing the content length.

### Method

```
func (c *Client) WriteStreamWithLength(path string, stream io.Reader, contentLength int64, _ os.FileMode) error
```
```

--------------------------------

### NewAuthClient Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a new WebDAV client with a specified authorizer.

```go
func NewAuthClient(uri string, auth Authorizer) *Client

```

--------------------------------

### List Files in a Directory

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Retrieve a list of files and directories within a specified path. The returned slice contains os.FileInfo types.

```go
files, _ := c.ReadDir("folder/subfolder")
for _, file := range files {
    //notice that [file] has os.FileInfo type
    fmt.Println(file.Name())
}

```

--------------------------------

### Client SetHeader Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Sets a custom header for all subsequent requests.

```go
func (c *Client) SetHeader(key, value string)

```

--------------------------------

### String Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads an io.Reader and returns its content as a string.

```go
func String(r io.Reader) string

```

--------------------------------

### Client Remove Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Removes a file or directory at the specified path.

```go
func (c *Client) Remove(path string) error

```

--------------------------------

### BasicAuth.String

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the BasicAuth credentials.

```APIDOC
###### func (*BasicAuth) String

### Description
String toString

### Signature
```go
func (b *BasicAuth) String() string
```
```

--------------------------------

### File IsDir Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Checks if the file represents a directory. Returns true if it's a directory, false otherwise.

```go
func (f File) IsDir() bool


```

--------------------------------

### Client Structure

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The Client struct defines the main structure for interacting with a WebDAV server.

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

--------------------------------

### File ContentType Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the content type of the file.

```go
func (f File) ContentType() string

```

--------------------------------

### PassportAuth String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the PassportAuth authenticator.

```go
func (p *PassportAuth) String() string

```

--------------------------------

### Join

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Joins two path strings together.

```APIDOC
## Join

### Description
Joins two paths.

### Signature
```go
func Join(path0 string, path1 string) string
```
```

--------------------------------

### File IsDir Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Checks if the file is a directory.

```go
func (f File) IsDir() bool

```

--------------------------------

### Read WebDAV configuration from .netrc

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

ReadConfig parses the ~/.netrc file to extract login and password credentials for a given machine URI.

```go
func ReadConfig(uri, netrc string) (string, string)
```

--------------------------------

### NewAuthClient

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a new WebDAV client instance with a custom Authorizer.

```APIDOC
###### func NewAuthClient

### Description
NewAuthClient creates a new client instance with a custom Authorizer

### Signature
```go
func NewAuthClient(uri string, auth Authorizer) *Client
```
```

--------------------------------

### BasicAuth.Clone

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a copy of the BasicAuth authenticator.

```APIDOC
###### func (*BasicAuth) Clone

### Description
Clone creates a Copy of itself

### Signature
```go
func (b *BasicAuth) Clone() Authenticator
```
```

--------------------------------

### Clone BasicAuth Instance

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The Clone method creates and returns a copy of the BasicAuth authenticator.

```go
func (b *BasicAuth) Clone() Authenticator
```

--------------------------------

### DigestAuth Verify Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Verifies the authentication response.

```go
func (d *DigestAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)

```

--------------------------------

### File Structure

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents a file within the WebDAV system. Contains metadata and methods for accessing file properties.

```go
type File struct {
    // contains filtered or unexported fields
}


```

--------------------------------

### Create Nested Directories on WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

MkdirAll creates a directory and any necessary parent directories, similar to 'mkdir -p'. The os.FileMode parameter is accepted but may not be fully utilized by all WebDAV servers.

```go
func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)
```

--------------------------------

### File ETag Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the ETag (entity tag) of the file. Used for conditional requests and caching.

```go
func (f File) ETag() string


```

--------------------------------

### Client WriteStreamWithLength Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Writes a stream of data to a specified path with a known content length. Requires the path, an io.Reader for the stream, the content length, and file mode.

```go
func (c *Client) WriteStreamWithLength(path string, stream io.Reader, contentLength int64, _ os.FileMode) (err error)


```

--------------------------------

### ReadConfig Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads WebDAV configuration from a URI and a netrc file.

```go
func ReadConfig(uri, netrc string) (string, string)

```

--------------------------------

### PassportAuth Authorize Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Authorizes a request using Passport Authentication.

```go
func (p *PassportAuth) Authorize(c *http.Client, rq *http.Request, path string) error

```

--------------------------------

### Client RemoveAll Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Removes a path and any children it contains.

```go
func (c *Client) RemoveAll(path string) error

```

--------------------------------

### NewPreemptiveAuth Function

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a preemptive authenticator using an existing authenticator.

```go
func NewPreemptiveAuth(auth Authenticator) Authorizer

```

--------------------------------

### Client.Copy

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Copies a file from a source path to a destination path, with an option to overwrite.

```APIDOC
###### func (*Client) Copy

### Description
Copy copies a file from A to B

### Signature
```go
func (c *Client) Copy(oldpath, newpath string, overwrite bool) error
```
```

--------------------------------

### Create Preemptive Authenticator

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Use NewPreemptiveAuth to create an authenticator that applies credentials to every request, regardless of the Www-Authenticate header. This method panics if AddAuthenticator is called.

```go
func NewPreemptiveAuth(auth Authenticator) Authorizer
```

--------------------------------

### Download File to Byte Array

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Read the content of a WebDAV file into a byte array. This is suitable for smaller files.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

bytes, _ := c.Read(webdavFilePath)
os.WriteFile(localFilePath, bytes, 0644)

```

--------------------------------

### NewEmptyAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates an empty Authenticator factory with auto-negotiation features.

```APIDOC
## NewEmptyAuth

### Description
NewEmptyAuth creates an empty Authenticator factory. The order of adding the Authenticator matters. First In, First Out. It offers the `NewAutoAuth` features.

### Signature
```go
func NewEmptyAuth() Authorizer
```
```

--------------------------------

### File ContentType Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the content type of the file. Useful for determining how to handle the file's data.

```go
func (f File) ContentType() string


```

--------------------------------

### Client

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents a WebDAV client.

```APIDOC
##### type Client

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

Client defines our structure
```

--------------------------------

### Client

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents a WebDAV client.

```APIDOC
## type Client

### Description
Client defines our structure.
```

```APIDOC
## func NewAuthClient(uri string, auth Authorizer) *Client

### Description
NewAuthClient creates a new client instance with a custom Authorizer.

### Parameters
* `uri` (string) - The base URI of the WebDAV server.
* `auth` (Authorizer) - The authorizer to use for authentication.
```

```APIDOC
## func NewClient(uri, user, pw string) *Client

### Description
NewClient creates a new instance of the client with basic authentication.

### Parameters
* `uri` (string) - The base URI of the WebDAV server.
* `user` (string) - The username for authentication.
* `pw` (string) - The password for authentication.
```

```APIDOC
## func (*Client) Connect() error

### Description
Connect establishes a connection to the WebDAV server.
```

```APIDOC
## func (*Client) Copy(oldpath, newpath string, overwrite bool) error

### Description
Copy copies a file or directory from `oldpath` to `newpath`. If `overwrite` is true, an existing file at `newpath` will be overwritten.

### Parameters
* `oldpath` (string) - The source path.
* `newpath` (string) - The destination path.
* `overwrite` (bool) - Whether to overwrite the destination if it exists.
```

```APIDOC
## func (*Client) Mkdir(path string, _ os.FileMode) (err error)

### Description
Mkdir creates a new directory at the specified path.

### Parameters
* `path` (string) - The path for the new directory.
* `_ os.FileMode` - File mode (often ignored for directories in WebDAV).
```

```APIDOC
## func (*Client) MkdirAll(path string, _ os.FileMode) (err error)

### Description
MkdirAll creates a directory and any necessary parent directories, similar to `mkdir -p`.

### Parameters
* `path` (string) - The path for the new directory.
* `_ os.FileMode` - File mode (often ignored for directories in WebDAV).
```

```APIDOC
## func (*Client) Read(path string) ([]byte, error)

### Description
Read reads the entire content of a remote file into a byte slice.

### Parameters
* `path` (string) - The path to the file to read.
```

```APIDOC
## func (*Client) ReadDir(path string) ([]os.FileInfo, error)

### Description
ReadDir reads the contents of a remote directory and returns a slice of `os.FileInfo`.

### Parameters
* `path` (string) - The path to the directory.
```

```APIDOC
## func (*Client) ReadStream(path string) (io.ReadCloser, error)

### Description
ReadStream opens a stream to read the content of a remote file.

### Parameters
* `path` (string) - The path to the file.
```

```APIDOC
## func (*Client) ReadStreamRange(path string, offset, length int64) (io.ReadCloser, error)

### Description
ReadStreamRange reads a specific byte range from a remote file. It utilizes HTTP Range Requests if supported by the server. If not, it emulates the behavior by skipping bytes and limiting the result.

### Parameters
* `path` (string) - The path to the file.
* `offset` (int64) - The starting byte offset from the beginning of the file.
* `length` (int64) - The number of bytes to read.
```

```APIDOC
## func (*Client) Remove(path string) error

### Description
Remove deletes a remote file.

### Parameters
* `path` (string) - The path to the file to remove.
```

```APIDOC
## func (*Client) RemoveAll(path string) error

### Description
RemoveAll deletes remote files and directories recursively. Use with caution.

### Parameters
* `path` (string) - The path to the file or directory to remove.
```

```APIDOC
## func (*Client) Rename(oldpath, newpath string, overwrite bool) error

### Description
Rename moves a file or directory from `oldpath` to `newpath`. If `overwrite` is true, an existing item at `newpath` will be overwritten.

### Parameters
* `oldpath` (string) - The original path.
* `newpath` (string) - The new path.
* `overwrite` (bool) - Whether to overwrite the destination if it exists.
```

```APIDOC
## func (*Client) SetHeader(key, value string)

### Description
SetHeader allows setting arbitrary HTTP headers for all subsequent requests made by this client.

### Parameters
* `key` (string) - The header key.
* `value` (string) - The header value.
```

```APIDOC
## func (*Client) SetInterceptor(interceptor func(method string, rq *http.Request))

### Description
SetInterceptor allows setting a custom function to intercept and modify outgoing HTTP requests.

### Parameters
* `interceptor` (func(method string, rq *http.Request)) - The interceptor function.
```

```APIDOC
## func (*Client) SetJar(jar http.CookieJar)

### Description
SetJar allows setting a custom `http.CookieJar` for managing cookies.

### Parameters
* `jar` (http.CookieJar) - The cookie jar to use.
```

```APIDOC
## func (*Client) SetTimeout(timeout time.Duration)

### Description
SetTimeout sets a time limit for all HTTP requests made by the client.

### Parameters
* `timeout` (time.Duration) - The maximum duration for a request.
```

```APIDOC
## func (*Client) SetTransport(transport http.RoundTripper)

### Description
SetTransport allows specifying a custom `http.RoundTripper` for handling HTTP requests, enabling advanced customization like custom connection pooling or proxying.

### Parameters
* `transport` (http.RoundTripper) - The custom transport to use.
```

```APIDOC
## func (*Client) Stat(path string) (os.FileInfo, error)

### Description
Stat retrieves file information (metadata) for a specified path.

### Parameters
* `path` (string) - The path to the file or directory.
```

```APIDOC
## func (*Client) Write(path string, data []byte, _ os.FileMode) (err error)

### Description
Write uploads data to a remote file. If the file exists, it will be overwritten.

### Parameters
* `path` (string) - The destination path for the file.
* `data` ([]byte) - The content to write to the file.
* `_ os.FileMode` - File mode (often ignored for files in WebDAV).
```

--------------------------------

### Join

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Joins two path segments together, ensuring correct path separators.

```APIDOC
## Join

### Description
Joins two path segments together, ensuring correct path separators.

### Signature
```go
func Join(path0 string, path1 string) string
```
```

--------------------------------

### BasicAuth.Verify

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Verifies if the authentication was successful.

```APIDOC
###### func (*BasicAuth) Verify

### Description
Verify verifies if the authentication

### Signature
```go
func (b *BasicAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)
```
```

--------------------------------

### File

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents a file or directory on the WebDAV server.

```APIDOC
## type File

### Description
File is our structure for a given file or directory.

### Methods
- **ContentType() string**: Returns the content type of a file.
- **ETag() string**: Returns the ETag of a file.
- **IsDir() bool**: Returns true if the item is a directory, false otherwise.
- **ModTime() time.Time**: Returns the last modification time of the file.
- **Mode() os.FileMode**: Returns the file mode.
- **Name() string**: Returns the name of the file.
- **Path() string**: Returns the full path of the file.
- **Size() int64**: Returns the size of the file in bytes.
- **String() string**: Returns a string representation of the file information.
- **Sys() interface{}**: Returns system-specific information.
```

--------------------------------

### PassportAuth Clone Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a copy of the PassportAuth authenticator. Useful for maintaining separate authentication states.

```go
func (p *PassportAuth) Clone() Authenticator


```

--------------------------------

### PassportAuth Clone Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a clone of the PassportAuth authenticator.

```go
func (p *PassportAuth) Clone() Authenticator

```

--------------------------------

### PassportAuth Verify Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Verifies the authentication response.

```go
func (p *PassportAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)

```

--------------------------------

### Download File via Reader

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Download a WebDAV file using a stream reader, which is efficient for large files. The content is copied to a local file.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

reader, _ := c.ReadStream(webdavFilePath)

file, _ := os.Create(localFilePath)
defer file.Close()

io.Copy(file, reader)

```

--------------------------------

### Copy File on WebDAV Server

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Use the Copy method to duplicate a file or directory from one path to another on the WebDAV server. An optional overwrite flag can be provided.

```go
func (c *Client) Copy(oldpath, newpath string, overwrite bool) error
```

--------------------------------

### DigestAuth Clone Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a copy of the DigestAuth authenticator. Useful for maintaining separate authentication states.

```go
func (d *DigestAuth) Clone() Authenticator


```

--------------------------------

### ReadConfig

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads login and password from a .netrc file for a given URI.

```APIDOC
## ReadConfig

### Description
ReadConfig reads login and password configuration from ~/.netrc for a given URI.

### Signature
```go
func ReadConfig(uri, netrc string) (string, string)
```
```

--------------------------------

### Verify Authentication with BasicAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The Verify method checks if the authentication was successful. It returns a boolean indicating if a redo is needed and an error if one occurred.

```go
func (b *BasicAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)
```

--------------------------------

### ReadConfig

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads login and password configuration from the ~/.netrc file for a given host.

```APIDOC
## ReadConfig

### Description
Reads login and password configuration from the ~/.netrc file for a given host.

### Signature
```go
func ReadConfig(uri, netrc string) (string, string)
```

### Example
```
~/.netrc machine foo.com login username password 123456
```
```

--------------------------------

### DigestAuth Authorize Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Authorizes a request using Digest Authentication.

```go
func (d *DigestAuth) Authorize(c *http.Client, rq *http.Request, path string) error

```

--------------------------------

### Basic Authentication Structure

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The BasicAuth struct is used to hold user credentials for authentication.

```go
type BasicAuth struct {
    // contains filtered or unexported fields
}
```

--------------------------------

### DigestAuth String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the DigestAuth authenticator.

```go
func (d *DigestAuth) String() string

```

--------------------------------

### NewPreemptiveAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a preemptive Authenticator that uses the provided Authenticator for every request, regardless of the `Www-Authenticate` header. This authorizer can only have one authentication method.

```APIDOC
## func NewPreemptiveAuth(auth Authenticator) Authorizer

### Description
Creates a preemptive Authenticator. The preemptive authorizer uses the provided Authenticator for every request regardless of any `Www-Authenticate` header. It may only have one authentication method, so calling `AddAuthenticator` will panic!

### Parameters
* `auth` (Authenticator) - The authenticator to use for preemptive authorization.
```

--------------------------------

### PassportAuth String Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns a string representation of the PassportAuth authenticator. Primarily for debugging or logging purposes.

```go
func (p *PassportAuth) String() string


```

--------------------------------

### NewEmptyAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates an empty Authenticator factory, offering the NewAutoAuth features.

```APIDOC
## NewEmptyAuth

### Description
Creates an empty Authenticator factory. The order of adding the Authenticator matters. First In, First Out. It offers the `NewAutoAuth` features.

### Signature
```go
func NewEmptyAuth() Authorizer
```
```

--------------------------------

### Client WriteStreamWithLength Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Writes data from a reader stream to a file, specifying the content length.

```go
func (c *Client) WriteStreamWithLength(path string, stream io.Reader, contentLength int64, _ os.FileMode) (err error)

```

--------------------------------

### Client SetTimeout Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Sets the request timeout for the client.

```go
func (c *Client) SetTimeout(timeout time.Duration)

```

--------------------------------

### DigestAuth Clone Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a clone of the DigestAuth authenticator.

```go
func (d *DigestAuth) Clone() Authenticator

```

--------------------------------

### Client.ReadDir

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Reads the contents of a remote directory and returns a slice of os.FileInfo.

```APIDOC
###### func (*Client) ReadDir

### Description
ReadDir reads the contents of a remote directory

### Signature
```go
func (c *Client) ReadDir(path string) ([]os.FileInfo, error)
```
```

--------------------------------

### BasicAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents basic authentication credentials for WebDAV.

```APIDOC
##### type BasicAuth

```go
type BasicAuth struct {
    // contains filtered or unexported fields
}
```

BasicAuth structure holds our credentials
```

--------------------------------

### GoWebDAV Function: FixSlashes

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Ensures a string has a leading and trailing slash.

```go
func FixSlashes(s string) string {
	// ... implementation omitted ...
}
```

--------------------------------

### Define XInhibitRedirect Constant

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Defines a constant for inhibiting redirects in WebDAV requests.

```go
const XInhibitRedirect = "X-Gowebdav-Inhibit-Redirect"

```

--------------------------------

### Utility Functions

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Helper functions for path manipulation and error checking.

```APIDOC
## FixSlash

### Description
Appends a trailing slash to a given string if it doesn't already have one.

### Signature
`func FixSlash(s string) string`

### Parameters
- `s` (string): The input string.

### Returns
- `string`: The string with a trailing slash appended if necessary.
```

```APIDOC
## FixSlashes

### Description
Ensures a string has a leading and trailing slash, adding them if they are missing.

### Signature
`func FixSlashes(s string) string`

### Parameters
- `s` (string): The input string.

### Returns
- `string`: The string with a leading and trailing slash.
```

```APIDOC
## IsErrCode

### Description
Checks if an error is a `StatusError` with a specific HTTP status code.

### Signature
`func IsErrCode(err error, code int) bool`

### Parameters
- `err` (error): The error to check.
- `code` (int): The HTTP status code to look for.

### Returns
- `bool`: True if the error matches the code, false otherwise.
```

```APIDOC
## IsErrNotFound

### Description
Checks if an error indicates that a resource was not found (typically HTTP 404).

### Signature
`func IsErrNotFound(err error) bool`

### Parameters
- `err` (error): The error to check.

### Returns
- `bool`: True if the error is a "not found" error, false otherwise.
```

```APIDOC
## Join

### Description
Joins two path segments together, ensuring correct slash separation.

### Signature
`func Join(path0 string, path1 string) string`

### Parameters
- `path0` (string): The first path segment.
- `path1` (string): The second path segment.

### Returns
- `string`: The joined path.
```

```APIDOC
## NewPathError

### Description
Creates a new `StatusError` with a specified operation, path, and HTTP status code.

### Signature
`func NewPathError(op string, path string, statusCode int) error`

### Parameters
- `op` (string): The operation that caused the error.
- `path` (string): The path involved in the error.
- `statusCode` (int): The HTTP status code associated with the error.

### Returns
- `error`: The newly created `StatusError`.
```

```APIDOC
## NewPathErrorErr

### Description
Creates a new `StatusError` wrapping an existing error, with a specified operation and path.

### Signature
`func NewPathErrorErr(op string, path string, err error) error`

### Parameters
- `op` (string): The operation that caused the error.
- `path` (string): The path involved in the error.
- `err` (error): The underlying error to wrap.

### Returns
- `error`: The newly created `StatusError`.
```

```APIDOC
## PathEscape

### Description
Escapes a path string for use in a URL, ensuring special characters are handled correctly.

### Signature
`func PathEscape(path string) string`

### Parameters
- `path` (string): The path string to escape.

### Returns
- `string`: The URL-escaped path string.
```

```APIDOC
## ReadConfig

### Description
Reads WebDAV configuration from a `.netrc` file or directly from provided URI and netrc path.

### Signature
`func ReadConfig(uri, netrc string) (string, string)`

### Parameters
- `uri` (string): The WebDAV server URI.
- `netrc` (string): The path to the `.netrc` file.

### Returns
- `string`: The username read from the configuration.
- `string`: The password read from the configuration.
```

```APIDOC
## String

### Description
Reads an `io.Reader` and returns its content as a string.

### Signature
`func String(r io.Reader) string`

### Parameters
- `r` (io.Reader): The reader to read from.

### Returns
- `string`: The content of the reader as a string.
```

--------------------------------

### Client SetInterceptor Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Sets an interceptor function that is called before each request.

```go
func (c *Client) SetInterceptor(interceptor func(method string, rq *http.Request))

```

--------------------------------

### WebDAV Constant: XInhibitRedirect

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Defines the X-Gowebdav-Inhibit-Redirect constant used for controlling redirects.

```go
const XInhibitRedirect = "X-Gowebdav-Inhibit-Redirect"
```

--------------------------------

### NewPreemptiveAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Creates a preemptive Authenticator that uses the provided Authenticator for every request, regardless of the Www-Authenticate header. This authorizer can only have one authentication method; calling AddAuthenticator will panic.

```APIDOC
## func NewPreemptiveAuth

### Description
Creates a preemptive Authenticator. The preemptive authorizer uses the provided Authenticator for every request regardless of any `Www-Authenticate` header. It may only have one authentication method, so calling `AddAuthenticator` **will panic**!

### Signature
```go
func NewPreemptiveAuth(auth Authenticator) Authorizer
```
```

--------------------------------

### File

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents a file or directory within the WebDAV file system.

```APIDOC
## type File

### Description
File is a structure representing a file or directory in the WebDAV file system.

### Methods
* **ContentType() string**: Returns the content type of the file.
* **ETag() string**: Returns the ETag of the file.
* **IsDir() bool**: Returns true if the file is a directory, false otherwise.
* **ModTime() time.Time**: Returns the last modification time of the file.
* **Mode() os.FileMode**: Returns the file mode.
* **Name() string**: Returns the name of the file.
* **Path() string**: Returns the full path of the file.
* **Size() int64**: Returns the size of the file in bytes.
* **String() string**: Returns a string representation of the file information.
* **Sys() interface{}**: Returns system-specific information about the file.
```

--------------------------------

### Client WriteStream Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Writes data from a reader stream to a file.

```go
func (c *Client) WriteStream(path string, stream io.Reader, _ os.FileMode) (err error)

```

--------------------------------

### File ModTime Method

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Returns the modification time of the file.

```go
func (f File) ModTime() time.Time

```

--------------------------------

### Authentication

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Provides different authentication mechanisms for WebDAV clients.

```APIDOC
## Authentication

### Authenticator Interface

The `Authenticator` interface defines methods for authenticating WebDAV requests.

### NewDigestAuth

Creates a new Digest authenticator.

### Method

```go
func NewDigestAuth(login, secret string, rs *http.Response) (Authenticator, error)
```

### NewPassportAuth

Creates a new Passport authenticator.

### Method

```go
func NewPassportAuth(c *http.Client, user, pw, partnerURL string, header *http.Header) (Authenticator, error)
```

### Authorizer Interface

The `Authorizer` interface defines methods for authorizing requests.

### NewAutoAuth

Creates a new automatic authenticator.

### Method

```go
func NewAutoAuth(login string, secret string) Authorizer
```

### NewEmptyAuth

Creates an authenticator that does not perform any authentication.

### Method

```go
func NewEmptyAuth() Authorizer
```

### NewPreemptiveAuth

Creates an authenticator that preemptively sends authentication credentials.

### Method

```go
func NewPreemptiveAuth(auth Authenticator) Authorizer
```

### BasicAuth

Represents Basic Authentication.

### Methods

- `Authorize(c *http.Client, rq *http.Request, path string) error`: Authorizes the request using Basic Authentication.
- `Clone() Authenticator`: Creates a clone of the BasicAuth authenticator.
- `Close() error`: Closes the BasicAuth authenticator.
- `String() string`: Returns a string representation of the BasicAuth authenticator.
- `Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)`: Verifies the authentication response.

### DigestAuth

Represents Digest Authentication.

### Methods

- `Authorize(c *http.Client, rq *http.Request, path string) error`: Authorizes the request using Digest Authentication.
- `Clone() Authenticator`: Creates a clone of the DigestAuth authenticator.
- `Close() error`: Closes the DigestAuth authenticator.
- `String() string`: Returns a string representation of the DigestAuth authenticator.
- `Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)`: Verifies the authentication response.

### PassportAuth

Represents Passport Authentication.

### Methods

- `Authorize(c *http.Client, rq *http.Request, path string) error`: Authorizes the request using Passport Authentication.
- `Clone() Authenticator`: Creates a clone of the PassportAuth authenticator.
- `Close() error`: Closes the PassportAuth authenticator.
- `String() string`: Returns a string representation of the PassportAuth authenticator.
- `Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)`: Verifies the authentication response.
```

--------------------------------

### String Representation of BasicAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

The String method provides a string representation of the BasicAuth object.

```go
func (b *BasicAuth) String() string
```

--------------------------------

### Upload File from Byte Array

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Upload a local file's content from a byte array to a WebDAV server. Ensure the byte array contains the complete file data.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

bytes, _ := os.ReadFile(localFilePath)

c.Write(webdavFilePath, bytes, 0644)

```

--------------------------------

### BasicAuth

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

Represents basic authentication credentials.

```APIDOC
## type BasicAuth

### Description
BasicAuth structure holds our credentials.
```

```APIDOC
## func (*BasicAuth) Authorize(c *http.Client, rq *http.Request, path string) error

### Description
Authorize the current request.
```

```APIDOC
## func (*BasicAuth) Clone() Authenticator

### Description
Clone creates a Copy of itself.
```

```APIDOC
## func (*BasicAuth) Close() error

### Description
Close cleans up all resources.
```

```APIDOC
## func (*BasicAuth) String() string

### Description
String converts the BasicAuth object to its string representation.
```

```APIDOC
## func (*BasicAuth) Verify(c *http.Client, rs *http.Response, path string) (redo bool, err error)

### Description
Verify verifies if the authentication was successful.
```

--------------------------------

### Create a new Passport Authenticator

Source: https://pkg.go.dev/github.com/studio-b12/gowebdav

NewPassportAuth constructs a PassportAuth object and performs an initial authentication against a partner URL. It requires an HTTP client, user credentials, partner URL, and optional headers.

```go
func NewPassportAuth(c *http.Client, user, pw, partnerURL string, header *http.Header) (Authenticator, error)
```
Tokens:
Raw