Documentation ¶
Overview ¶
Package cmd contains all the global variables and constants. ONLY TO BE ACCESSED VIA GET/SET FUNCTIONS.
Package cmd - session V8 - Version 8 stores session header and session data in two separate files. Session data contains fully prepared URL list.
Package cmd - This file implements a simple trie tree to be used for 'mc' cli commands.
Index ¶
- Constants
- Variables
- func DamerauLevenshteinDistance(a string, b string) int
- func IsDeleteEvent(event notify.Event) bool
- func IsPutEvent(event notify.Event) bool
- func Main()
- type APINotImplemented
- type BrokenSymlink
- type BucketDoesNotExist
- type BucketExists
- type BucketInvalid
- type BucketNameEmpty
- type BucketNameTopLevel
- type Client
- type Comparer
- type Config
- type DirOpt
- type DummyStatus
- func (ds *DummyStatus) Add(v int64) Status
- func (ds *DummyStatus) Finish()
- func (ds *DummyStatus) PrintMsg(msg message)
- func (ds *DummyStatus) Println(data ...interface{})
- func (ds *DummyStatus) Read(p []byte) (n int, err error)
- func (ds *DummyStatus) SetCaption(s string)
- func (ds *DummyStatus) SetTotal(v int64) Status
- func (ds *DummyStatus) Start()
- func (ds *DummyStatus) Total() int64
- func (ds *DummyStatus) Update()
- type EmptyPath
- type Event
- type EventType
- type GenericBucketError
- type GenericFileError
- type ObjectAlreadyExists
- type ObjectAlreadyExistsAsDirectory
- type ObjectMissing
- type ObjectOnGlacier
- type PathInsufficientPermission
- type PathIsNotRegular
- type PathNotFound
- type ProgressStatus
- func (ps *ProgressStatus) Add(v int64) Status
- func (ps *ProgressStatus) Finish()
- func (ps *ProgressStatus) PrintMsg(msg message)
- func (ps *ProgressStatus) Println(data ...interface{})
- func (ps *ProgressStatus) Read(p []byte) (n int, err error)
- func (p ProgressStatus) Set64(length int64) *progressBar
- func (ps *ProgressStatus) SetCaption(s string)
- func (ps *ProgressStatus) SetTotal(v int64) Status
- func (ps *ProgressStatus) Start()
- func (ps *ProgressStatus) Total() int64
- func (ps *ProgressStatus) Update()
- type Queue
- type QuietStatus
- func (qs *QuietStatus) Add(v int64) Status
- func (qs *QuietStatus) Finish()
- func (qs *QuietStatus) PrintMsg(msg message)
- func (qs *QuietStatus) Println(data ...interface{})
- func (qs *QuietStatus) Read(p []byte) (n int, err error)
- func (a QuietStatus) Set(n int64) *accounter
- func (qs *QuietStatus) SetCaption(s string)
- func (qs *QuietStatus) SetTotal(v int64) Status
- func (qs *QuietStatus) Start()
- func (a QuietStatus) Stat() accountStat
- func (qs *QuietStatus) Total() int64
- func (qs *QuietStatus) Update()
- type Status
- type TooManyLevelsSymlink
- type Trie
- type URLs
- type UnexpectedEOF
- type UnexpectedExcessRead
- type UnexpectedShortWrite
- type Watcher
Constants ¶
const Day = 24 * time.Hour
Day time.Duration for day.
Variables ¶
var ( // Version - version time.RFC3339. Version = "DEVELOPMENT.GOGET" // ReleaseTag - release tag in TAG.%Y-%m-%dT%H-%M-%SZ. ReleaseTag = "DEVELOPMENT.GOGET" // CommitID - latest commit id. CommitID = "DEVELOPMENT.GOGET" // ShortCommitID - first 12 characters from CommitID. ShortCommitID = CommitID[:12] )
var ( // EventTypePut contains the notify events that will cause a put EventTypePut = []notify.Event{notify.InCloseWrite | notify.InMovedTo} // EventTypeDelete contains the notify events that will cause a delete EventTypeDelete = []notify.Event{notify.InDelete | notify.InDeleteSelf | notify.InMovedFrom} )
var ErrObjectAlreadyQueued = fmt.Errorf("Object already queued")
ErrObjectAlreadyQueued occurs when the object being pushed already exists in the queue
Functions ¶
func DamerauLevenshteinDistance ¶
DamerauLevenshteinDistance calculates distance between two strings using an algorithm described in https://en.wikipedia.org/wiki/Damerau-Levenshtein_distance
func IsDeleteEvent ¶
IsDeleteEvent checks if the event returned is a delete event
func IsPutEvent ¶
IsPutEvent checks if the event returned is a put event
Types ¶
type APINotImplemented ¶
APINotImplemented - api not implemented
func (APINotImplemented) Error ¶
func (e APINotImplemented) Error() string
type BrokenSymlink ¶
type BrokenSymlink GenericFileError
BrokenSymlink (ENOTENT) - file has broken symlink.
func (BrokenSymlink) Error ¶
func (e BrokenSymlink) Error() string
type BucketDoesNotExist ¶
type BucketDoesNotExist GenericBucketError
BucketDoesNotExist - bucket does not exist.
func (BucketDoesNotExist) Error ¶
func (e BucketDoesNotExist) Error() string
type BucketExists ¶
type BucketExists GenericBucketError
BucketExists - bucket exists.
func (BucketExists) Error ¶
func (e BucketExists) Error() string
type BucketInvalid ¶
type BucketInvalid struct {
Bucket string
}
BucketInvalid - bucket name invalid.
func (BucketInvalid) Error ¶
func (e BucketInvalid) Error() string
type BucketNameEmpty ¶
type BucketNameEmpty struct{}
BucketNameEmpty - bucket name empty (http://goo.gl/wJlzDz)
func (BucketNameEmpty) Error ¶
func (e BucketNameEmpty) Error() string
type BucketNameTopLevel ¶
type BucketNameTopLevel struct{}
BucketNameTopLevel - generic error
func (BucketNameTopLevel) Error ¶
func (e BucketNameTopLevel) Error() string
type Client ¶
type Client interface { // Common operations Stat(isIncomplete bool) (content *clientContent, err *probe.Error) List(isRecursive, isIncomplete bool, showDir DirOpt) <-chan *clientContent // Bucket operations MakeBucket(region string) *probe.Error // Access policy operations. GetAccess() (access string, error *probe.Error) GetAccessRules() (policyRules map[string]string, error *probe.Error) SetAccess(access string) *probe.Error // I/O operations Copy(source string, size int64, progress io.Reader) *probe.Error // I/O operations with metadata. Get() (reader io.Reader, metadata map[string][]string, err *probe.Error) Put(reader io.Reader, size int64, metadata map[string][]string, progress io.Reader) (n int64, err *probe.Error) // I/O operations with expiration // Watch events Watch(params watchParams) (*watchObject, *probe.Error) // Delete operations Remove(isIncomplete bool, contentCh <-chan *clientContent) (errorCh <-chan *probe.Error) // GetURL returns back internal url GetURL() clientURL }
Client - client interface
type Comparer ¶
type Comparer interface {
Equal(interface{}) bool
}
Comparer is an interface for queued objects, used to identify duplicate objects in queue.
type Config ¶
type Config struct { AccessKey string SecretKey string Signature string HostURL string AppName string AppVersion string AppComments []string Debug bool Insecure bool }
Config - see http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html?RESTAuthentication.html
type DummyStatus ¶
type DummyStatus struct{}
DummyStatus will not show anything.
func (*DummyStatus) Add ¶
func (ds *DummyStatus) Add(v int64) Status
Add bytes to current number of bytes
func (*DummyStatus) Println ¶
func (ds *DummyStatus) Println(data ...interface{})
Println prints line, ignored for quietstatus
func (*DummyStatus) Read ¶
func (ds *DummyStatus) Read(p []byte) (n int, err error)
Read implements the io.Reader interface
func (*DummyStatus) SetCaption ¶
func (ds *DummyStatus) SetCaption(s string)
SetCaption sets the caption of the progressbar, ignored for quietstatus
func (*DummyStatus) SetTotal ¶
func (ds *DummyStatus) SetTotal(v int64) Status
SetTotal sets the total of the progressbar, ignored for quietstatus
func (*DummyStatus) Total ¶
func (ds *DummyStatus) Total() int64
Total returns the total number of bytes
type Event ¶
type Event struct { Time string `json:"time"` Size int64 `json:"size"` Path string `json:"path"` Client Client `json:"-"` Type EventType `json:"type"` }
Event contains the information of the event that occurred
type EventType ¶
type EventType string
EventType is the type of the event that occurred
const ( // EventCreate notifies when a new object has been created EventCreate EventType = "ObjectCreated" // EventRemove notifies when a new object has been deleted EventRemove = "ObjectRemoved" )
type GenericBucketError ¶
type GenericBucketError struct {
Bucket string
}
GenericBucketError - generic bucket operations error
type GenericFileError ¶
type GenericFileError struct {
Path string
}
GenericFileError - generic file error.
type ObjectAlreadyExists ¶
type ObjectAlreadyExists struct {
Object string
}
ObjectAlreadyExists - typed return for MethodNotAllowed
func (ObjectAlreadyExists) Error ¶
func (e ObjectAlreadyExists) Error() string
type ObjectAlreadyExistsAsDirectory ¶
type ObjectAlreadyExistsAsDirectory struct {
Object string
}
ObjectAlreadyExistsAsDirectory - typed return for XMinioObjectExistsAsDirectory
func (ObjectAlreadyExistsAsDirectory) Error ¶
func (e ObjectAlreadyExistsAsDirectory) Error() string
type ObjectMissing ¶
type ObjectMissing struct{}
ObjectMissing (EINVAL) - object key missing.
func (ObjectMissing) Error ¶
func (e ObjectMissing) Error() string
type ObjectOnGlacier ¶
type ObjectOnGlacier struct {
Object string
}
ObjectOnGlacier - object is of storage class glacier.
func (ObjectOnGlacier) Error ¶
func (e ObjectOnGlacier) Error() string
type PathInsufficientPermission ¶
type PathInsufficientPermission GenericFileError
PathInsufficientPermission (EPERM) - permission denied.
func (PathInsufficientPermission) Error ¶
func (e PathInsufficientPermission) Error() string
type PathIsNotRegular ¶
type PathIsNotRegular GenericFileError
PathIsNotRegular (ENOTREG) - file is not a regular file.
func (PathIsNotRegular) Error ¶
func (e PathIsNotRegular) Error() string
type PathNotFound ¶
type PathNotFound GenericFileError
PathNotFound (ENOENT) - file not found.
func (PathNotFound) Error ¶
func (e PathNotFound) Error() string
type ProgressStatus ¶
type ProgressStatus struct {
// contains filtered or unexported fields
}
ProgressStatus shows a progressbar
func (*ProgressStatus) Add ¶
func (ps *ProgressStatus) Add(v int64) Status
Add bytes to current number of bytes
func (*ProgressStatus) Finish ¶
func (ps *ProgressStatus) Finish()
Finish displays the accounting summary
func (*ProgressStatus) PrintMsg ¶
func (ps *ProgressStatus) PrintMsg(msg message)
PrintMsg prints message
func (*ProgressStatus) Println ¶
func (ps *ProgressStatus) Println(data ...interface{})
Println prints line, ignored for quietstatus
func (*ProgressStatus) Read ¶
func (ps *ProgressStatus) Read(p []byte) (n int, err error)
Read implements the io.Reader interface
func (*ProgressStatus) SetCaption ¶
func (ps *ProgressStatus) SetCaption(s string)
SetCaption sets the caption of the progressbar
func (*ProgressStatus) SetTotal ¶
func (ps *ProgressStatus) SetTotal(v int64) Status
SetTotal sets the total of the progressbar
func (*ProgressStatus) Total ¶
func (ps *ProgressStatus) Total() int64
Total returns the total number of bytes
func (*ProgressStatus) Update ¶
func (ps *ProgressStatus) Update()
Update is ignored for quietstatus
type Queue ¶
type Queue struct {
// contains filtered or unexported fields
}
Queue allows objects to be queued on a first in first out base.
type QuietStatus ¶
type QuietStatus struct {
// contains filtered or unexported fields
}
QuietStatus will only show the progress and summary
func (*QuietStatus) Add ¶
func (qs *QuietStatus) Add(v int64) Status
Add bytes to current number of bytes
func (*QuietStatus) Println ¶
func (qs *QuietStatus) Println(data ...interface{})
Println prints line, ignored for quietstatus
func (*QuietStatus) Read ¶
func (qs *QuietStatus) Read(p []byte) (n int, err error)
Read implements the io.Reader interface
func (QuietStatus) Set ¶
func (a QuietStatus) Set(n int64) *accounter
Set sets the current value atomically.
func (*QuietStatus) SetCaption ¶
func (qs *QuietStatus) SetCaption(s string)
SetCaption sets the caption of the progressbar, ignored for quietstatus
func (*QuietStatus) SetTotal ¶
func (qs *QuietStatus) SetTotal(v int64) Status
SetTotal sets the total of the progressbar, ignored for quietstatus
func (QuietStatus) Stat ¶
func (a QuietStatus) Stat() accountStat
Stat provides current stats captured.
func (*QuietStatus) Total ¶
func (qs *QuietStatus) Total() int64
Total returns the total number of bytes
type Status ¶
type Status interface { Println(data ...interface{}) Add(int64) Status Start() Finish() PrintMsg(msg message) Update() Total() int64 SetTotal(int64) Status SetCaption(string) Read(p []byte) (n int, err error) // contains filtered or unexported methods }
Status implements a interface that can be used in quit mode or with progressbar.
func NewProgressStatus ¶
func NewProgressStatus() Status
NewProgressStatus returns a progress status object
type TooManyLevelsSymlink ¶
type TooManyLevelsSymlink GenericFileError
TooManyLevelsSymlink (ELOOP) - file has too many levels of symlinks.
func (TooManyLevelsSymlink) Error ¶
func (e TooManyLevelsSymlink) Error() string
type Trie ¶
type Trie struct {
// contains filtered or unexported fields
}
Trie is a trie container.
func (*Trie) PrefixMatch ¶
PrefixMatch - prefix match.
type URLs ¶
type URLs struct { SourceAlias string SourceContent *clientContent TargetAlias string TargetContent *clientContent TotalCount int64 TotalSize int64 Error *probe.Error `json:"-"` }
URLs contains source and target urls
type UnexpectedEOF ¶
UnexpectedEOF (EPIPE) - reader closed prematurely.
func (UnexpectedEOF) Error ¶
func (e UnexpectedEOF) Error() string
type UnexpectedExcessRead ¶
type UnexpectedExcessRead UnexpectedEOF
UnexpectedExcessRead - reader wrote more data than requested.
func (UnexpectedExcessRead) Error ¶
func (e UnexpectedExcessRead) Error() string
type UnexpectedShortWrite ¶
UnexpectedShortWrite - write wrote less bytes than expected.
func (UnexpectedShortWrite) Error ¶
func (e UnexpectedShortWrite) Error() string
type Watcher ¶
type Watcher struct {
// contains filtered or unexported fields
}
Watcher can be used to have one or multiple clients watch for notifications
func NewWatcher ¶
NewWatcher creates a new watcher
Source Files ¶
- access-perms.go
- accounting-reader.go
- build-constants.go
- cat-main.go
- certs.go
- client-errors.go
- client-fs.go
- client-fs_linux.go
- client-s3-trace_v2.go
- client-s3-trace_v4.go
- client-s3.go
- client-url.go
- client.go
- common-methods.go
- config-fix.go
- config-host-main.go
- config-main.go
- config-migrate.go
- config-old.go
- config-utils.go
- config-v8.go
- config-validate.go
- config.go
- cp-main.go
- cp-url-syntax.go
- cp-url.go
- damerau-levenshtein.go
- diff-main.go
- difference.go
- error.go
- events-add.go
- events-list.go
- events-main.go
- events-remove.go
- flags.go
- fs-pathutils.go
- globals.go
- ls-main.go
- ls.go
- main.go
- mb-main.go
- mirror-main.go
- mirror-url.go
- notifier.go
- pipe-main.go
- policy-main.go
- print.go
- progress-bar.go
- queue.go
- rm-main.go
- runtime-checks.go
- scan-bar.go
- session-main.go
- session-migrate.go
- session-old.go
- session-v8.go
- session.go
- share-db-v1.go
- share-download-main.go
- share-list-main.go
- share-main.go
- share-upload-main.go
- share.go
- signals.go
- status.go
- time.go
- trie.go
- typed-errors.go
- update-main.go
- urls.go
- utils.go
- version-main.go
- watch-main.go
- watch.go