irods

package
v0.0.0-...-08f17c8 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: BSD-3-Clause Imports: 12 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type IRODSFSClient 

type IRODSFSClient interface {
	Release()

	GetAccount() *irodsclient_types.IRODSAccount
	GetApplicationName() string

	GetConnections() int
	GetMetrics() *irodsclient_metrics.IRODSMetrics

	// API
	List(path string) ([]*irodsclient_fs.Entry, error)
	Stat(path string) (*irodsclient_fs.Entry, error)
	ListXattr(path string) ([]*irodsclient_types.IRODSMeta, error)
	GetXattr(path string, name string) (*irodsclient_types.IRODSMeta, error)
	SetXattr(path string, name string, value string) error
	RemoveXattr(path string, name string) error
	ExistsDir(path string) bool
	ExistsFile(path string) bool
	ListUserGroups(user string) ([]*irodsclient_types.IRODSUser, error)
	ListDirACLs(path string) ([]*irodsclient_types.IRODSAccess, error)
	ListFileACLs(path string) ([]*irodsclient_types.IRODSAccess, error)
	ListACLsForEntries(path string) ([]*irodsclient_types.IRODSAccess, error)
	RemoveFile(path string, force bool) error
	RemoveDir(path string, recurse bool, force bool) error
	MakeDir(path string, recurse bool) error
	RenameDirToDir(srcPath string, destPath string) error
	RenameFileToFile(srcPath string, destPath string) error
	CreateFile(path string, resource string, mode string) (IRODSFSFileHandle, error)
	OpenFile(path string, resource string, mode string) (IRODSFSFileHandle, error)
	TruncateFile(path string, size int64) error

	// Cache
	AddCacheEventHandler(handler irodsclient_fs.FilesystemCacheEventHandler) (string, error)
	RemoveCacheEventHandler(handlerID string) error
}

func NewIRODSFSClientDirect 

func NewIRODSFSClientDirect(account *irodsclient_types.IRODSAccount, config *irodsclient_fs.FileSystemConfig) (IRODSFSClient, error)

NewIRODSFSClientDirect creates IRODSFSClient using IRODSFSClientDirect

func NewIRODSFSClientOverlay 

func NewIRODSFSClientOverlay(account *irodsclient_types.IRODSAccount, config *irodsclient_fs.FileSystemConfig, inodeManager *inode.InodeManager, overlayDirPath string) (IRODSFSClient, error)

NewIRODSFSClientOverlay creates IRODSFSClient using IRODSFSClientOverlay

type IRODSFSClientDirect 

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

IRODSFSClientDirect implements IRODSClient interface with go-irodsclient direct access to iRODS server implements interfaces defined in interface.go

func (*IRODSFSClientDirect) AddCacheEventHandler 

func (client *IRODSFSClientDirect) AddCacheEventHandler(handler irodsclient_fs.FilesystemCacheEventHandler) (string, error)

func (*IRODSFSClientDirect) CreateFile 

func (client *IRODSFSClientDirect) CreateFile(path string, resource string, mode string) (IRODSFSFileHandle, error)

CreateFile creates a file

func (*IRODSFSClientDirect) ExistsDir 

func (client *IRODSFSClientDirect) ExistsDir(path string) bool

ExistsDir checks existance of a dir

func (*IRODSFSClientDirect) ExistsFile 

func (client *IRODSFSClientDirect) ExistsFile(path string) bool

ExistsFile checks existance of a file

func (*IRODSFSClientDirect) GetAccount 

func (client *IRODSFSClientDirect) GetAccount() *irodsclient_types.IRODSAccount

GetAccount returns iRODS Account info

func (*IRODSFSClientDirect) GetApplicationName 

func (client *IRODSFSClientDirect) GetApplicationName() string

GetApplicationName returns application name

func (*IRODSFSClientDirect) GetConnections 

func (client *IRODSFSClientDirect) GetConnections() int

GetConnections() returns total number of connections

func (*IRODSFSClientDirect) GetFSClient 

func (client *IRODSFSClientDirect) GetFSClient() *irodsclient_fs.FileSystem

GetFSClient returns iRODS fs client

func (*IRODSFSClientDirect) GetMetrics 

func (client *IRODSFSClientDirect) GetMetrics() *irodsclient_metrics.IRODSMetrics

GetTransferMetrics() returns transfer metrics

func (*IRODSFSClientDirect) GetXattr 

func (client *IRODSFSClientDirect) GetXattr(path string, name string) (*irodsclient_types.IRODSMeta, error)

GetXattr returns xattr value

func (*IRODSFSClientDirect) List 

func (client *IRODSFSClientDirect) List(path string) ([]*irodsclient_fs.Entry, error)

List lists directory entries

func (*IRODSFSClientDirect) ListACLsForEntries 

func (client *IRODSFSClientDirect) ListACLsForEntries(path string) ([]*irodsclient_types.IRODSAccess, error)

ListACLsForEntries lists ACLs for entries in a collection

func (*IRODSFSClientDirect) ListDirACLs 

func (client *IRODSFSClientDirect) ListDirACLs(path string) ([]*irodsclient_types.IRODSAccess, error)

ListDirACLs lists directory ACLs

func (*IRODSFSClientDirect) ListFileACLs 

func (client *IRODSFSClientDirect) ListFileACLs(path string) ([]*irodsclient_types.IRODSAccess, error)

ListFileACLs lists file ACLs

func (*IRODSFSClientDirect) ListUserGroups 

func (client *IRODSFSClientDirect) ListUserGroups(user string) ([]*irodsclient_types.IRODSUser, error)

ListUserGroups lists user groups

func (*IRODSFSClientDirect) ListXattr 

func (client *IRODSFSClientDirect) ListXattr(path string) ([]*irodsclient_types.IRODSMeta, error)

ListXattr lists xattr

func (*IRODSFSClientDirect) MakeDir 

func (client *IRODSFSClientDirect) MakeDir(path string, recurse bool) error

MakeDir makes a new directory

func (*IRODSFSClientDirect) OpenFile 

func (client *IRODSFSClientDirect) OpenFile(path string, resource string, mode string) (IRODSFSFileHandle, error)

OpenFile opens a file

func (*IRODSFSClientDirect) Release 

func (client *IRODSFSClientDirect) Release()

Release releases resources

func (*IRODSFSClientDirect) RemoveCacheEventHandler 

func (client *IRODSFSClientDirect) RemoveCacheEventHandler(handlerID string) error

func (*IRODSFSClientDirect) RemoveDir 

func (client *IRODSFSClientDirect) RemoveDir(path string, recurse bool, force bool) error

RemoveDir removes a directory

func (*IRODSFSClientDirect) RemoveFile 

func (client *IRODSFSClientDirect) RemoveFile(path string, force bool) error

RemoveFile removes a file

func (*IRODSFSClientDirect) RemoveXattr 

func (client *IRODSFSClientDirect) RemoveXattr(path string, name string) error

RemoveXattr removes xattr

func (*IRODSFSClientDirect) RenameDirToDir 

func (client *IRODSFSClientDirect) RenameDirToDir(srcPath string, destPath string) error

RenameDirToDir renames a directory, dest path is also a non-existing path for dir

func (*IRODSFSClientDirect) RenameFileToFile 

func (client *IRODSFSClientDirect) RenameFileToFile(srcPath string, destPath string) error

RenameFileToFile renames a file, dest path is also a non-existing path for file

func (*IRODSFSClientDirect) SetXattr 

func (client *IRODSFSClientDirect) SetXattr(path string, name string, value string) error

SetXattr sets xattr

func (*IRODSFSClientDirect) Stat 

func (client *IRODSFSClientDirect) Stat(path string) (*irodsclient_fs.Entry, error)

Stat stats fs entry

func (*IRODSFSClientDirect) TruncateFile 

func (client *IRODSFSClientDirect) TruncateFile(path string, size int64) error

TruncateFile truncates a file

type IRODSFSClientDirectFileHandle 

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

IRODSFSClientDirectFileHandle implements IRODSFSFileHandle

func (*IRODSFSClientDirectFileHandle) Close 

func (handle *IRODSFSClientDirectFileHandle) Close() error

func (*IRODSFSClientDirectFileHandle) Flush 

func (handle *IRODSFSClientDirectFileHandle) Flush() error

func (*IRODSFSClientDirectFileHandle) GetAvailable 

func (handle *IRODSFSClientDirectFileHandle) GetAvailable(offset int64) int64

func (*IRODSFSClientDirectFileHandle) GetEntry 

func (handle *IRODSFSClientDirectFileHandle) GetEntry() *irodsclient_fs.Entry

func (*IRODSFSClientDirectFileHandle) GetID 

func (handle *IRODSFSClientDirectFileHandle) GetID() string

func (*IRODSFSClientDirectFileHandle) GetOffset 

func (handle *IRODSFSClientDirectFileHandle) GetOffset() int64

func (*IRODSFSClientDirectFileHandle) GetOpenMode 

func (handle *IRODSFSClientDirectFileHandle) GetOpenMode() irodsclient_types.FileOpenMode

func (*IRODSFSClientDirectFileHandle) IsReadMode 

func (handle *IRODSFSClientDirectFileHandle) IsReadMode() bool

func (*IRODSFSClientDirectFileHandle) IsWriteMode 

func (handle *IRODSFSClientDirectFileHandle) IsWriteMode() bool

func (*IRODSFSClientDirectFileHandle) Lock 

func (handle *IRODSFSClientDirectFileHandle) Lock(wait bool) error

func (*IRODSFSClientDirectFileHandle) RLock 

func (handle *IRODSFSClientDirectFileHandle) RLock(wait bool) error

func (*IRODSFSClientDirectFileHandle) ReadAt 

func (handle *IRODSFSClientDirectFileHandle) ReadAt(buffer []byte, offset int64) (int, error)

func (*IRODSFSClientDirectFileHandle) Truncate 

func (handle *IRODSFSClientDirectFileHandle) Truncate(size int64) error

func (*IRODSFSClientDirectFileHandle) Unlock 

func (handle *IRODSFSClientDirectFileHandle) Unlock() error

func (*IRODSFSClientDirectFileHandle) WriteAt 

func (handle *IRODSFSClientDirectFileHandle) WriteAt(data []byte, offset int64) (int, error)

type IRODSFSClientOverlay 

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

IRODSFSClientOverlay implements IRODSClient interface with go-irodsclient but with overlay file I/O is first sent to local disk then sent to iRODS server direct access to iRODS server implements interfaces defined in interface.go

func (*IRODSFSClientOverlay) AddCacheEventHandler 

func (client *IRODSFSClientOverlay) AddCacheEventHandler(handler irodsclient_fs.FilesystemCacheEventHandler) (string, error)

func (*IRODSFSClientOverlay) CreateFile 

func (client *IRODSFSClientOverlay) CreateFile(irodsPath string, resource string, mode string) (IRODSFSFileHandle, error)

CreateFile creates a file

func (*IRODSFSClientOverlay) ExistsDir 

func (client *IRODSFSClientOverlay) ExistsDir(irodsPath string) bool

ExistsDir checks existance of a dir

func (*IRODSFSClientOverlay) ExistsFile 

func (client *IRODSFSClientOverlay) ExistsFile(irodsPath string) bool

ExistsFile checks existance of a file

func (*IRODSFSClientOverlay) GetAccount 

func (client *IRODSFSClientOverlay) GetAccount() *irodsclient_types.IRODSAccount

GetAccount returns iRODS Account info

func (*IRODSFSClientOverlay) GetApplicationName 

func (client *IRODSFSClientOverlay) GetApplicationName() string

GetApplicationName returns application name

func (*IRODSFSClientOverlay) GetConnections 

func (client *IRODSFSClientOverlay) GetConnections() int

GetConnections() returns total number of connections

func (*IRODSFSClientOverlay) GetMetrics 

func (client *IRODSFSClientOverlay) GetMetrics() *irodsclient_metrics.IRODSMetrics

GetTransferMetrics() returns transfer metrics

func (*IRODSFSClientOverlay) GetXattr 

func (client *IRODSFSClientOverlay) GetXattr(irodsPath string, name string) (*irodsclient_types.IRODSMeta, error)

GetXattr returns xattr value

func (*IRODSFSClientOverlay) List 

func (client *IRODSFSClientOverlay) List(irodsPath string) ([]*irodsclient_fs.Entry, error)

List lists directory entries

func (*IRODSFSClientOverlay) ListACLsForEntries 

func (client *IRODSFSClientOverlay) ListACLsForEntries(irodsPath string) ([]*irodsclient_types.IRODSAccess, error)

ListACLsForEntries lists ACLs for entries in a collection

func (*IRODSFSClientOverlay) ListDirACLs 

func (client *IRODSFSClientOverlay) ListDirACLs(irodsPath string) ([]*irodsclient_types.IRODSAccess, error)

ListDirACLs lists directory ACLs

func (*IRODSFSClientOverlay) ListFileACLs 

func (client *IRODSFSClientOverlay) ListFileACLs(irodsPath string) ([]*irodsclient_types.IRODSAccess, error)

ListFileACLs lists file ACLs

func (*IRODSFSClientOverlay) ListUserGroups 

func (client *IRODSFSClientOverlay) ListUserGroups(user string) ([]*irodsclient_types.IRODSUser, error)

ListUserGroups lists user groups

func (*IRODSFSClientOverlay) ListXattr 

func (client *IRODSFSClientOverlay) ListXattr(irodsPath string) ([]*irodsclient_types.IRODSMeta, error)

ListXattr lists xattr

func (*IRODSFSClientOverlay) MakeDir 

func (client *IRODSFSClientOverlay) MakeDir(irodsPath string, recurse bool) error

MakeDir makes a new directory

func (*IRODSFSClientOverlay) OpenFile 

func (client *IRODSFSClientOverlay) OpenFile(irodsPath string, resource string, mode string) (IRODSFSFileHandle, error)

OpenFile opens a file

func (*IRODSFSClientOverlay) Release 

func (client *IRODSFSClientOverlay) Release()

Release releases resources

func (*IRODSFSClientOverlay) RemoveCacheEventHandler 

func (client *IRODSFSClientOverlay) RemoveCacheEventHandler(handlerID string) error

func (*IRODSFSClientOverlay) RemoveDir 

func (client *IRODSFSClientOverlay) RemoveDir(irodsPath string, recurse bool, force bool) error

RemoveDir removes a directory

func (*IRODSFSClientOverlay) RemoveFile 

func (client *IRODSFSClientOverlay) RemoveFile(irodsPath string, force bool) error

RemoveFile removes a file

func (*IRODSFSClientOverlay) RemoveXattr 

func (client *IRODSFSClientOverlay) RemoveXattr(irodsPath string, name string) error

RemoveXattr removes xattr

func (*IRODSFSClientOverlay) RenameDirToDir 

func (client *IRODSFSClientOverlay) RenameDirToDir(srcPath string, destPath string) error

RenameDirToDir renames a directory, dest path is also a non-existing path for dir

func (*IRODSFSClientOverlay) RenameFileToFile 

func (client *IRODSFSClientOverlay) RenameFileToFile(srcPath string, destPath string) error

RenameFileToFile renames a file, dest path is also a non-existing path for file

func (*IRODSFSClientOverlay) SetXattr 

func (client *IRODSFSClientOverlay) SetXattr(irodsPath string, name string, value string) error

SetXattr sets xattr

func (*IRODSFSClientOverlay) Stat 

func (client *IRODSFSClientOverlay) Stat(irodsPath string) (*irodsclient_fs.Entry, error)

Stat stats fs entry

func (*IRODSFSClientOverlay) TruncateFile 

func (client *IRODSFSClientOverlay) TruncateFile(irodsPath string, size int64) error

TruncateFile truncates a file

type IRODSFSClientOverlayFileHandle 

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

IRODSFSClientOverlayFileHandle implements IRODSFSFileHandle

func (*IRODSFSClientOverlayFileHandle) Close 

func (handle *IRODSFSClientOverlayFileHandle) Close() error

func (*IRODSFSClientOverlayFileHandle) Flush 

func (handle *IRODSFSClientOverlayFileHandle) Flush() error

func (*IRODSFSClientOverlayFileHandle) GetAvailable 

func (handle *IRODSFSClientOverlayFileHandle) GetAvailable(offset int64) int64

func (*IRODSFSClientOverlayFileHandle) GetEntry 

func (handle *IRODSFSClientOverlayFileHandle) GetEntry() *irodsclient_fs.Entry

func (*IRODSFSClientOverlayFileHandle) GetID 

func (handle *IRODSFSClientOverlayFileHandle) GetID() string

func (*IRODSFSClientOverlayFileHandle) GetOffset 

func (handle *IRODSFSClientOverlayFileHandle) GetOffset() int64

func (*IRODSFSClientOverlayFileHandle) GetOpenMode 

func (handle *IRODSFSClientOverlayFileHandle) GetOpenMode() irodsclient_types.FileOpenMode

func (*IRODSFSClientOverlayFileHandle) IsReadMode 

func (handle *IRODSFSClientOverlayFileHandle) IsReadMode() bool

func (*IRODSFSClientOverlayFileHandle) IsWriteMode 

func (handle *IRODSFSClientOverlayFileHandle) IsWriteMode() bool

func (*IRODSFSClientOverlayFileHandle) Lock 

func (handle *IRODSFSClientOverlayFileHandle) Lock(wait bool) error

func (*IRODSFSClientOverlayFileHandle) RLock 

func (handle *IRODSFSClientOverlayFileHandle) RLock(wait bool) error

func (*IRODSFSClientOverlayFileHandle) ReadAt 

func (handle *IRODSFSClientOverlayFileHandle) ReadAt(buffer []byte, offset int64) (int, error)

func (*IRODSFSClientOverlayFileHandle) Truncate 

func (handle *IRODSFSClientOverlayFileHandle) Truncate(size int64) error

func (*IRODSFSClientOverlayFileHandle) Unlock 

func (handle *IRODSFSClientOverlayFileHandle) Unlock() error

func (*IRODSFSClientOverlayFileHandle) WriteAt 

func (handle *IRODSFSClientOverlayFileHandle) WriteAt(data []byte, offset int64) (int, error)

type IRODSFSFileHandle 

type IRODSFSFileHandle interface {
	GetID() string
	GetEntry() *irodsclient_fs.Entry
	GetOpenMode() irodsclient_types.FileOpenMode
	GetOffset() int64
	IsReadMode() bool
	IsWriteMode() bool
	ReadAt(buffer []byte, offset int64) (int, error)
	GetAvailable(offset int64) int64
	WriteAt(data []byte, offset int64) (int, error)
	Lock(wait bool) error
	RLock(wait bool) error
	Unlock() error
	Truncate(size int64) error
	Flush() error
	Close() error
}

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.