backup

package

v0.0.0-...-c11c497 Latest Latest Go to latest Published: Mar 27, 2024 License: GPL-3.0 Imports: 23 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/0x07cf-dev/go-backup

Documentation ¶

Index ¶

Variables
type BackupError
- func (e BackupError) Localize(langs ...string) string
type BackupErrorCode
- func (e BackupErrorCode) Error(source string, message string) BackupError
- func (e BackupErrorCode) ID() string
type BackupOptFunc
type BackupOpts
type BackupSession
- func NewSession(ctx context.Context, options ...BackupOptFunc) *BackupSession
type CmdFunc

Constants ¶

This section is empty.

Variables ¶

View Source

var CommandMap = map[string]CmdFunc{
	"!sleep": cmdSleep,
}

Functions ¶

This section is empty.

Types ¶

type BackupError ¶

type BackupError struct {
	Code    BackupErrorCode
	Source  string
	Message string
}

func (BackupError) Localize ¶

func (e BackupError) Localize(langs ...string) string

type BackupErrorCode ¶

type BackupErrorCode int8

const (
	GenericError BackupErrorCode = iota
	CmdInvalid
	CmdFailed
	PathError
	UploadError
	DownloadError
)

func (BackupErrorCode) Error ¶

func (e BackupErrorCode) Error(source string, message string) BackupError

func (BackupErrorCode) ID ¶

func (e BackupErrorCode) ID() string

type BackupOptFunc ¶

type BackupOptFunc func(*BackupOpts)

func WithDebug ¶

func WithDebug(debug bool) BackupOptFunc

func WithDownload ¶

func WithDownload() BackupOptFunc

func WithInteractivity ¶

func WithInteractivity(interactive bool) BackupOptFunc

func WithLanguages ¶

func WithLanguages(langs ...string) BackupOptFunc

func WithRemote ¶

func WithRemote(remote string) BackupOptFunc

func WithRemoteRoot ¶

func WithRemoteRoot(remoteRoot string) BackupOptFunc

func WithSimulation ¶

func WithSimulation(simulate bool) BackupOptFunc

type BackupOpts ¶

type BackupOpts struct {
	Remote      string
	RemoteRoot  string
	Uploading   bool
	Simulate    bool
	Interactive bool
	Debug       bool
	Languages   []string
}

type BackupSession ¶

type BackupSession struct {
	Opts     *BackupOpts
	Machine  *config.Machine
	Notifier *notify.Notifier
	// contains filtered or unexported fields
}

func NewSession ¶

func NewSession(ctx context.Context, options ...BackupOptFunc) *BackupSession

func (*BackupSession) Backup ¶

func (session *BackupSession) Backup()

func (*BackupSession) Heartbeat ¶

func (session *BackupSession) Heartbeat(endpoint string, withLog bool)

func (*BackupSession) NotifyStatus ¶

func (session *BackupSession) NotifyStatus(status string, statusTags ...string)

type CmdFunc ¶

type CmdFunc func(chan BackupError, string) string

Source Files ¶

View all Source files

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