commons

package
v0.2.24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 8, 2026 License: BSD-3-Clause Imports: 40 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ClientProgramName string                     = "md-repo-cli"
	FilesystemTimeout irodsclient_types.Duration = irodsclient_types.Duration(10 * time.Minute)

	SubmissionMetadataFilename string = "mdrepo-metadata.toml"

	MaxSimulationSubmissionSize string = "40GiB"
)
View Source 
const (
	KiloBytes int64 = 1024
	MegaBytes int64 = KiloBytes * 1024
	GigaBytes int64 = MegaBytes * 1024
	TeraBytes int64 = GigaBytes * 1024

	Minute int = 60
	Hour   int = Minute * 60
	Day    int = Hour * 24
)

Variables

View Source 
var (
	TokenNotProvidedError error = errors.Errorf("token not provided")
	InvalidOrcIDError     error = errors.Errorf("invalid ORC-ID")
)

Functions

func Base64Decode added in v0.1.4 

func Base64Decode(str string) ([]byte, error)

func CalculateThreadForTransferJob added in v0.2.8 

func CalculateThreadForTransferJob(fileSize int64, maxThreads int) int

func CheckNewRelease 

func CheckNewRelease() (*selfupdate.Release, error)

func DownloadFileWebDAV added in v0.2.10 

func DownloadFileWebDAV(sourceEntry *irodsclient_fs.Entry, localPath string, ticket string, callback irodsclient_common.TransferTrackerCallback) (*irodsclient_fs.FileTransferResult, error)

func ExistFile 

func ExistFile(p string) bool

func ExpandHomeDir added in v0.2.2 

func ExpandHomeDir(p string) (string, error)

func FirstDelimeterIndex added in v0.2.8 

func FirstDelimeterIndex(p string) int

func Fprintf added in v0.2.1 

func Fprintf(w io.Writer, format string, a ...any) (int, error)

func GetAccount 

func GetAccount(ticket *MDRepoTicket) (*irodsclient_types.IRODSAccount, error)

func GetBasename 

func GetBasename(p string) string

func GetClientVersion 

func GetClientVersion() string

GetClientVersion returns client version in string

func GetCommonRootLocalDirPath added in v0.2.8 

func GetCommonRootLocalDirPath(paths []string) (string, error)

func GetDefaultTCPBufferSize added in v0.2.8 

func GetDefaultTCPBufferSize() int

func GetDefaultTCPBufferSizeString added in v0.2.8 

func GetDefaultTCPBufferSizeString() string

func GetDefaultTransferThreadNum added in v0.2.8 

func GetDefaultTransferThreadNum() int

func GetDefaultTransferThreadNumPerFile added in v0.2.10 

func GetDefaultTransferThreadNumPerFile() int

func GetDir added in v0.1.4 

func GetDir(p string) string

func GetFileExtension 

func GetFileExtension(p string) string

func GetIRODSConnection 

func GetIRODSConnection(account *irodsclient_types.IRODSAccount) (*irodsclient_conn.IRODSConnection, error)

GetIRODSConnection returns a connection

func GetIRODSFSClient 

func GetIRODSFSClient(account *irodsclient_types.IRODSAccount) (*irodsclient_fs.FileSystem, error)

GetIRODSFSClient returns a file system client

func GetIRODSFSClientForLargeFileIO added in v0.2.2 

func GetIRODSFSClientForLargeFileIO(account *irodsclient_types.IRODSAccount, maxIOConnection int, tcpBufferSize int) (*irodsclient_fs.FileSystem, error)

GetIRODSFSClientForLargeFileIO returns a file system client

func GetIRODSPathBasename added in v0.2.8 

func GetIRODSPathBasename(path string) string

func GetIRODSPathDirname added in v0.2.8 

func GetIRODSPathDirname(path string) string

func GetMDRepoSimulationRelPath added in v0.2.1 

func GetMDRepoSimulationRelPath(irodsPath string) (string, error)

func GetMDRepoTicketString added in v0.1.4 

func GetMDRepoTicketString(tickets []MDRepoTicket) (string, error)

func GetMDRepoTicketStringFromToken added in v0.1.4 

func GetMDRepoTicketStringFromToken(serviceURL string, token string) (string, error)

func GetMaxSimulationSubmissionSize added in v0.2.22 

func GetMaxSimulationSubmissionSize() int64

func GetParentIRODSDirs added in v0.2.1 

func GetParentIRODSDirs(p string) []string

GetParentIRODSDirs returns all parent dirs

func GetParentLocalDirs added in v0.2.1 

func GetParentLocalDirs(p string) []string

GetParentLocalDirs returns all parent dirs

func GetProgressWriter added in v0.2.0 

func GetProgressWriter(displayPath bool) progress.Writer

func GetShortPathMessage added in v0.2.0 

func GetShortPathMessage(name string, messageLen int) string

func GetShortTrackerMessage added in v0.2.23 

func GetShortTrackerMessage(taskType string, taskName string, messageLen int) string

func GetSubmitMetadataPath added in v0.1.6 

func GetSubmitMetadataPath(dirPath string) string

func GetTrackerName added in v0.2.23 

func GetTrackerName(taskType string, taskName string) string

func GetVersionJSON 

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

func GetVersionParts 

func GetVersionParts(version string) (int, int, int)

GetVersionParts returns version parts (major, minor, patch)

func GetWebDAVErrorCode added in v0.2.20 

func GetWebDAVErrorCode(err error) (int, bool)

func GetWebDAVPathForIRODSPath added in v0.2.10 

func GetWebDAVPathForIRODSPath(irodsPath string, ticket string) string

func GetWebDavError added in v0.2.20 

func GetWebDavError(url string, err error) error

func HMACStringSHA224 added in v0.1.4 

func HMACStringSHA224(secret []byte, str string) (string, error)

func HMACStrings added in v0.1.4 

func HMACStrings(secret []byte, strs []string, hashAlg func() hash.Hash) (string, error)

func HasNewRelease added in v0.2.21 

func HasNewRelease(myVersion string, latestVersion string) bool

func HasSubmitMetadataInDir added in v0.1.4 

func HasSubmitMetadataInDir(dirPath string) bool

func InitTerminalOutput added in v0.2.1 

func InitTerminalOutput()

func Input added in v0.2.1 

func Input(msg string) string

func InputInt added in v0.2.1 

func InputInt(msg string) int

func InputMissingFields 

func InputMissingFields() (bool, error)

InputMissingFields inputs missing fields

func InputMissingFieldsFromStdin 

func InputMissingFieldsFromStdin() error

InputMissingFieldsFromStdin inputs missing fields

func InputOrcID added in v0.1.4 

func InputOrcID() string

InputOrcID inputs ORCID

func InputPassword added in v0.2.1 

func InputPassword(msg string) string

func InputSimulationNo added in v0.1.4 

func InputSimulationNo() int

InputSimulationNo inputs simulation no

func InputYN 

func InputYN(msg string, showAll bool) bool

InputYN inputs Y or N true for Y, false for N

func IsDialHTTPError added in v0.2.5 

func IsDialHTTPError(err error) bool

IsDialHTTPError evaluates if the given error is DialHTTPError

func IsInvalidSubmitMetadataError added in v0.2.20 

func IsInvalidSubmitMetadataError(err error) bool

IsInvalidSubmitMetadataError evaluates if the given error is InvalidSubmitMetadataError

func IsInvalidTicketError added in v0.2.0 

func IsInvalidTicketError(err error) bool

IsInvalidTicketError evaluates if the given error is InvalidTicketError

func IsMDRepoServiceError added in v0.2.0 

func IsMDRepoServiceError(err error) bool

IsMDRepoServiceError evaluates if the given error is MDRepoServiceError

func IsNewerVersion 

func IsNewerVersion(ver1 []int, ver2 []int) bool

IsNewerVersion compares ver1 against ver2

func IsNotDirError added in v0.2.1 

func IsNotDirError(err error) bool

IsNotDirError evaluates if the given error is NotDirError

func IsNotFileError added in v0.2.1 

func IsNotFileError(err error) bool

IsNotFileError evaluates if the given error is NotFileError

func IsSimulationNoNotMatchingError added in v0.1.7 

func IsSimulationNoNotMatchingError(err error) bool

IsSimulationNoNotMatchingError evaluates if the given error is SimulationNoNotMatchingError

func IsStatusFile added in v0.1.3 

func IsStatusFile(filename string) bool

func IsWebDAVError added in v0.2.20 

func IsWebDAVError(err error) bool

IsWebDAVError evaluates if the given error is WebDAVError

func LastDelimeterIndex added in v0.2.8 

func LastDelimeterIndex(p string) int

func MakeDateTimeFromString 

func MakeDateTimeFromString(str string) (time.Time, error)

func MakeDateTimeString 

func MakeDateTimeString(t time.Time) string

func MakeDateTimeStringHM added in v0.2.8 

func MakeDateTimeStringHM(t time.Time) string

func MakeIRODSLandingPath 

func MakeIRODSLandingPath(irodsPath string) string

func MakeIRODSReleasePath 

func MakeIRODSReleasePath(irodsPath string) string

func MakeLocalPath 

func MakeLocalPath(localPath string) string

func MakeTargetIRODSFilePath 

func MakeTargetIRODSFilePath(filesystem *irodsclient_fs.FileSystem, source string, target string, createSub bool) string

func MakeTargetLocalFilePath 

func MakeTargetLocalFilePath(source string, target string, createSub bool) string

func MarkIRODSPathMap added in v0.2.8 

func MarkIRODSPathMap(pathMap map[string]bool, p string)

func MarkLocalPathMap added in v0.2.8 

func MarkLocalPathMap(pathMap map[string]bool, p string)

func NewDialHTTPError added in v0.2.5 

func NewDialHTTPError(url string) error

func NewInvalidSubmitMetadataError added in v0.2.20 

func NewInvalidSubmitMetadataError() error

func NewInvalidTicketError added in v0.2.0 

func NewInvalidTicketError(ticket string) error

func NewMDRepoServiceError added in v0.2.0 

func NewMDRepoServiceError(message string) error

func NewNotDirError added in v0.2.1 

func NewNotDirError(dest string) error

func NewNotFileError added in v0.2.1 

func NewNotFileError(dest string) error

func NewSimulationNoNotMatchingError added in v0.1.7 

func NewSimulationNoNotMatchingError(valid []string, invalid []string, invalidErrors []error, expected int) error

NewSimulationNoNotMatchingError creates a simulation no not matching error

func NewWebDAVError added in v0.2.20 

func NewWebDAVError(url string, errorCode int) error

func ParseSize 

func ParseSize(size string) (uint64, error)

func ParseTime 

func ParseTime(t string) (int, error)

func Print added in v0.2.1 

func Print(a ...any) (n int, err error)

func PrintErrorf added in v0.2.1 

func PrintErrorf(format string, a ...any) (int, error)

func PrintInfof added in v0.2.1 

func PrintInfof(format string, a ...any) (n int, err error)

func PrintInfoln added in v0.2.1 

func PrintInfoln(a ...any) (n int, err error)

func Printf added in v0.2.1 

func Printf(format string, a ...any) (n int, err error)

func Println added in v0.2.1 

func Println(a ...any) (n int, err error)
func ResolveSymlink(p string) (string, error)

func RunWithRetry 

func RunWithRetry(retry int, retryInterval int) error

func SelfUpgrade 

func SelfUpgrade(release *selfupdate.Release) error

func SetDefaultConfigIfEmpty 

func SetDefaultConfigIfEmpty()

func ToSizeString added in v0.2.22 

func ToSizeString(size uint64) string

func VerifySubmitMetadataViaServer added in v0.2.18 

func VerifySubmitMetadataViaServer(sourcePaths []string, serviceURL string, token string) error

Types

type Config 

type Config struct {
	Token        string
	TicketString string
}

func GetConfig 

func GetConfig() *Config

func GetDefaultConfig 

func GetDefaultConfig() *Config

func (*Config) ToConfigTypeIn 

func (config *Config) ToConfigTypeIn() *ConfigTypeIn

type ConfigTypeIn 

type ConfigTypeIn struct {
	TicketString string `yaml:"ticket_string,omitempty"`
}

func NewConfigTypeInFromYAML 

func NewConfigTypeInFromYAML(yamlBytes []byte) (*ConfigTypeIn, error)

NewConfigTypeInFromYAML creates ConfigTypeIn from YAML

func (*ConfigTypeIn) ToYAML 

func (config *ConfigTypeIn) ToYAML() ([]byte, error)

ToYAML converts to YAML bytes

type DialHTTPError added in v0.2.5 

type DialHTTPError struct {
	URL string
}

func (*DialHTTPError) Error added in v0.2.5 

func (err *DialHTTPError) Error() string

Error returns error message

func (*DialHTTPError) Is added in v0.2.5 

func (err *DialHTTPError) Is(other error) bool

Is tests type of error

func (*DialHTTPError) ToString added in v0.2.5 

func (err *DialHTTPError) ToString() string

ToString stringifies the object

type InvalidSubmitMetadataError added in v0.1.6 

type InvalidSubmitMetadataError struct {
	Errors []error
}

func (*InvalidSubmitMetadataError) Add added in v0.2.20 

func (err *InvalidSubmitMetadataError) Add(message error)

func (*InvalidSubmitMetadataError) Error added in v0.2.20 

func (err *InvalidSubmitMetadataError) Error() string

Error returns error message

func (*InvalidSubmitMetadataError) ErrorLen added in v0.2.20 

func (err *InvalidSubmitMetadataError) ErrorLen() int

func (*InvalidSubmitMetadataError) Is added in v0.2.20 

func (err *InvalidSubmitMetadataError) Is(other error) bool

Is tests type of error

func (*InvalidSubmitMetadataError) ToString added in v0.2.20 

func (err *InvalidSubmitMetadataError) ToString() string

ToString stringifies the object

type InvalidTicketError added in v0.1.3 

type InvalidTicketError struct {
	Ticket string
}

func (*InvalidTicketError) Error added in v0.2.0 

func (err *InvalidTicketError) Error() string

Error returns error message

func (*InvalidTicketError) Is added in v0.2.0 

func (err *InvalidTicketError) Is(other error) bool

Is tests type of error

func (*InvalidTicketError) ToString added in v0.2.0 

func (err *InvalidTicketError) ToString() string

ToString stringifies the object

type MDRepoServiceError added in v0.2.0 

type MDRepoServiceError struct {
	Message string
}

func (*MDRepoServiceError) Error added in v0.2.0 

func (err *MDRepoServiceError) Error() string

Error returns error message

func (*MDRepoServiceError) Is added in v0.2.0 

func (err *MDRepoServiceError) Is(other error) bool

Is tests type of error

func (*MDRepoServiceError) ToString added in v0.2.0 

func (err *MDRepoServiceError) ToString() string

ToString stringifies the object

type MDRepoSubmitMetadata added in v0.2.18 

type MDRepoSubmitMetadata struct {
	MetadataFilePath string `toml:"-"`
	SubmissionPath   string `toml:"-"`

	Initial map[string]interface{} `toml:"initial"`

	RequiredFiles   map[string]string   `toml:"required_files"`
	AdditionalFiles []map[string]string `toml:"additional_files"`
}

func ParseSubmitMetadataDir added in v0.2.18 

func ParseSubmitMetadataDir(dirPath string) (*MDRepoSubmitMetadata, error)

func ParseSubmitMetadataFile added in v0.2.18 

func ParseSubmitMetadataFile(filePath string) (*MDRepoSubmitMetadata, error)

func ParseSubmitMetadataString added in v0.2.18 

func ParseSubmitMetadataString(metadataString string) (*MDRepoSubmitMetadata, error)

func (*MDRepoSubmitMetadata) GetFiles added in v0.2.18 

func (meta *MDRepoSubmitMetadata) GetFiles() []string

func (*MDRepoSubmitMetadata) GetOrcID added in v0.2.18 

func (meta *MDRepoSubmitMetadata) GetOrcID() (string, error)

func (*MDRepoSubmitMetadata) ValidateFiles added in v0.2.18 

func (meta *MDRepoSubmitMetadata) ValidateFiles() error

type MDRepoTicket 

type MDRepoTicket struct {
	IRODSTicket   string
	IRODSDataPath string
}

func GetMDRepoTicketFromString added in v0.1.4 

func GetMDRepoTicketFromString(ticketString string) (MDRepoTicket, error)

func GetMDRepoTicketsFromString added in v0.1.4 

func GetMDRepoTicketsFromString(ticketString string) ([]MDRepoTicket, error)

type MDRepoTicketObject added in v0.1.4 

type MDRepoTicketObject struct {
	TicketString string `json:"tickets"`
}

type MDRepoVerifySubmitMetadataRequest added in v0.2.18 

type MDRepoVerifySubmitMetadataRequest struct {
	LocalDataDirPath string `json:"directory"`
	MetadataTOML     string `json:"toml"`
	Token            string `json:"token"`
}

type MDRepoVerifySubmitMetadataResponse added in v0.2.18 

type MDRepoVerifySubmitMetadataResponse struct {
	LocalDataDirPath string   `json:"directory"`
	Valid            bool     `json:"valid"`
	Errors           []string `json:"errors"`
}

type NotDirError added in v0.2.1 

type NotDirError struct {
	Path string
}

func (*NotDirError) Error added in v0.2.1 

func (err *NotDirError) Error() string

Error returns error message

func (*NotDirError) Is added in v0.2.1 

func (err *NotDirError) Is(other error) bool

Is tests type of error

func (*NotDirError) ToString added in v0.2.1 

func (err *NotDirError) ToString() string

ToString stringifies the object

type NotFileError added in v0.2.1 

type NotFileError struct {
	Path string
}

func (*NotFileError) Error added in v0.2.1 

func (err *NotFileError) Error() string

Error returns error message

func (*NotFileError) Is added in v0.2.1 

func (err *NotFileError) Is(other error) bool

Is tests type of error

func (*NotFileError) ToString added in v0.2.1 

func (err *NotFileError) ToString() string

ToString stringifies the object

type ParallelJob 

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

func (*ParallelJob) Done added in v0.2.0 

func (job *ParallelJob) Done()

func (*ParallelJob) GetManager 

func (job *ParallelJob) GetManager() *ParallelJobManager

func (*ParallelJob) Progress 

func (job *ParallelJob) Progress(taskType string, processed int64, total int64, errored bool)

type ParallelJobManager 

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

func NewParallelJobManager 

func NewParallelJobManager(fs *irodsclient_fs.FileSystem, maxThreads int, showProgress bool, showFullPath bool) *ParallelJobManager

NewParallelJobManager creates a new ParallelJobManager

func (*ParallelJobManager) DoneScheduling 

func (manager *ParallelJobManager) DoneScheduling()

func (*ParallelJobManager) GetFilesystem 

func (manager *ParallelJobManager) GetFilesystem() *irodsclient_fs.FileSystem

func (*ParallelJobManager) Schedule 

func (manager *ParallelJobManager) Schedule(name string, task ParallelJobTask, threadsRequired int, progressUnit progress.Units) error

func (*ParallelJobManager) Start 

func (manager *ParallelJobManager) Start()

func (*ParallelJobManager) Wait 

func (manager *ParallelJobManager) Wait() error

type ParallelJobTask 

type ParallelJobTask func(job *ParallelJob) error

type ProgressTrackerCallback 

type ProgressTrackerCallback func(taskType string, taskName string, processed int64, total int64, unit progress.Units, errored bool)

type SimulationNoNotMatchingError added in v0.1.4 

type SimulationNoNotMatchingError struct {
	ValidSimulationPaths         []string
	InvalidSimulationPaths       []string
	InvalidSimulationPathsErrors []error
	Expected                     int
}

func (*SimulationNoNotMatchingError) Error added in v0.1.7 

func (err *SimulationNoNotMatchingError) Error() string

Error returns error message

func (*SimulationNoNotMatchingError) Is added in v0.1.7 

func (err *SimulationNoNotMatchingError) Is(other error) bool

Is tests type of error

func (*SimulationNoNotMatchingError) ToString added in v0.1.7 

func (err *SimulationNoNotMatchingError) ToString() string

ToString stringifies the object

type SubmitStatus 

type SubmitStatus string
const (
	SubmitStatusUnknown    SubmitStatus = "unknown"
	SubmitStatusInProgress SubmitStatus = "inprogress"
	SubmitStatusErrored    SubmitStatus = "errored"
	SubmitStatusCompleted  SubmitStatus = "completed"
)

func (SubmitStatus) MarshalJSON 

func (s SubmitStatus) MarshalJSON() ([]byte, error)

func (SubmitStatus) String 

func (s SubmitStatus) String() string

func (*SubmitStatus) UnmarshalJSON 

func (s *SubmitStatus) UnmarshalJSON(b []byte) error

type SubmitStatusEntry 

type SubmitStatusEntry struct {
	IRODSPath string `json:"irods_path"`
	Size      int64  `json:"size"`
	MD5Hash   string `json:"md5_hash"`
}

type SubmitStatusFile 

type SubmitStatusFile struct {
	TotalFileNumer int64               `json:"total_filenum"`
	TotalFileSize  int64               `json:"total_filesize"`
	Token          string              `json:"token"`
	Status         SubmitStatus        `json:"status"`
	Files          []SubmitStatusEntry `json:"files"`
	Time           time.Time           `json:"time"`
}

func NewSubmitStatusFile 

func NewSubmitStatusFile() *SubmitStatusFile

func (*SubmitStatusFile) AddFile 

func (s *SubmitStatusFile) AddFile(f SubmitStatusEntry)

func (*SubmitStatusFile) CreateStatusFile added in v0.1.3 

func (s *SubmitStatusFile) CreateStatusFile(filesystem *fs.FileSystem, dataRootPath string) error

func (*SubmitStatusFile) GetStatusFilename added in v0.1.3 

func (s *SubmitStatusFile) GetStatusFilename() string

func (*SubmitStatusFile) SetCompleted 

func (s *SubmitStatusFile) SetCompleted()

func (*SubmitStatusFile) SetErrored 

func (s *SubmitStatusFile) SetErrored()

func (*SubmitStatusFile) SetInProgress 

func (s *SubmitStatusFile) SetInProgress()

type TerminalWriter added in v0.2.1 

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

func GetTerminalWriter added in v0.2.1 

func GetTerminalWriter() *TerminalWriter

func (*TerminalWriter) Lock added in v0.2.1 

func (writer *TerminalWriter) Lock()

func (*TerminalWriter) Unlock added in v0.2.1 

func (writer *TerminalWriter) Unlock()

func (*TerminalWriter) Write added in v0.2.1 

func (writer *TerminalWriter) Write(p []byte) (n int, err error)

type TransferMethod added in v0.2.1 

type TransferMethod string

TransferMethod determines transfer method 

const (
	// TransferMethodGet is for get
	TransferMethodGet TransferMethod = "GET"
	// TransferMethodPut is for put
	TransferMethodPut TransferMethod = "PUT"
	// TransferMethodBput is for bput command
	TransferMethodBput TransferMethod = "BPUT"
	// TransferMethodCopy is for cp command
	TransferMethodCopy TransferMethod = "COPY"
	// TransferMethodDelete is for delete command
	TransferMethodDelete TransferMethod = "DELETE"
	// TransferMethodBputUnknown is for unknown command
	TransferMethodBputUnknown TransferMethod = "UNKNOWN"
)

func GetTransferMethod added in v0.2.1 

func GetTransferMethod(method string) TransferMethod

GetTransferMethod returns transfer method

type TransferMode added in v0.2.8 

type TransferMode string
const (
	TransferModeICAT     TransferMode = "icat"
	TransferModeRedirect TransferMode = "redirect"
	TransferModeWebDAV   TransferMode = "webdav"
)

func (TransferMode) Valid added in v0.2.8 

func (t TransferMode) Valid() bool

type TransferReportFile added in v0.2.1 

type TransferReportFile struct {
	Method TransferMethod `json:"method"` // get, put, bput ...

	StartAt time.Time `json:"start_time"`
	EndAt   time.Time `json:"end_at"`

	SourcePath              string `json:"source_path"`
	DestPath                string `json:"dest_path"`
	SourceSize              int64  `json:"source_size"`
	SourceChecksumAlgorithm string `json:"source_checksum_algorithm"`
	SourceChecksum          string `json:"source_checksum"`
	DestSize                int64  `json:"dest_size"`
	DestChecksumAlgorithm   string `json:"dest_checksum_algorithm"`
	DestChecksum            string `json:"dest_checksum"`

	Error error    `json:"error,omitempty"`
	Notes []string `json:"notes"` // additional notes
}

func NewTransferReportFileFromTransferResult added in v0.2.1 

func NewTransferReportFileFromTransferResult(result *irodsclient_fs.FileTransferResult, method TransferMethod, err error, notes []string) (*TransferReportFile, error)

type TransferReportManager added in v0.2.1 

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

func NewTransferReportManager added in v0.2.1 

func NewTransferReportManager(report bool, reportPath string, reportToStdout bool) (*TransferReportManager, error)

NewTransferReportManager creates a new TransferReportManager

func (*TransferReportManager) AddFile added in v0.2.1 

func (manager *TransferReportManager) AddFile(file *TransferReportFile) error

AddFile adds a new file transfer

func (*TransferReportManager) AddTransfer added in v0.2.1 

func (manager *TransferReportManager) AddTransfer(result *irodsclient_fs.FileTransferResult, method TransferMethod, err error, notes []string) error

AddTransfer adds a new file transfer

func (*TransferReportManager) Release added in v0.2.1 

func (manager *TransferReportManager) Release()

Release releases resources

type VersionInfo 

type VersionInfo struct {
	ClientVersion string `json:"clientVersion"`
	GitCommit     string `json:"gitCommit"`
	BuildDate     string `json:"buildDate"`
	GoVersion     string `json:"goVersion"`
	Compiler      string `json:"compiler"`
	Platform      string `json:"platform"`
}

VersionInfo object contains version related info

func GetVersion 

func GetVersion() VersionInfo

GetVersion returns VersionInfo object

type WebDAVError added in v0.2.20 

type WebDAVError struct {
	URL       string
	ErrorCode int
}

func (*WebDAVError) Error added in v0.2.20 

func (err *WebDAVError) Error() string

Error returns error message

func (*WebDAVError) Is added in v0.2.20 

func (err *WebDAVError) Is(other error) bool

Is tests type of error

func (*WebDAVError) ToString added in v0.2.20 

func (err *WebDAVError) ToString() string

ToString stringifies the object

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.