dotfileclient

package

v1.0.6 Latest Latest Go to latest Published: Oct 7, 2023 License: GPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/knoebber/dotfile

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func New(remote, username, token string) *Client
type Revision

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Client   *http.Client
	Remote   string
	Username string
	Token    string
}

Client contains a http client and the information needed for interacting with the dotfilehub api.

func New ¶

func New(remote, username, token string) *Client

New returns a client that is ready to communicate with a dotfilehub server.

func (*Client) Content ¶

func (c *Client) Content(alias string) ([]byte, error)

Content fetches the current content of alias.

func (*Client) List ¶

func (c *Client) List(path bool) ([]string, error)

List lists the files that the remote user has saved.

func (*Client) Revisions ¶

func (c *Client) Revisions(alias string, hashes []string) ([]*Revision, error)

Revisions fetches all of the revisions for alias in the hashes argument. Returns an error if any fetches fail or are non 200.

func (*Client) TrackingData ¶

func (c *Client) TrackingData(alias string) (*dotfile.TrackingData, error)

TrackingData returns the file tracking data for alias on remote.

func (*Client) TrackingDataBytes ¶

func (c *Client) TrackingDataBytes(alias string) ([]byte, error)

TrackingDataBytes returns the tracking data for alias in bytes.

func (*Client) UploadRevisions ¶

func (c *Client) UploadRevisions(alias string, data *dotfile.TrackingData, revisions []*Revision) error

UploadRevisions uploads revisions to remote using a multipart POST request. The first part is the fileData JSON the rest are form files with the revision bytes.

type Revision ¶

type Revision struct {
	Hash  string
	Bytes []byte
}

Revision is the bytes of a revision and its hash. Note that the bytes would not hash to Hash - its from the original uncompressed content.

Source Files ¶

View all Source files

dotfileclient.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL