fs

package

v0.14.5 Latest Latest Go to latest Published: Apr 30, 2024 License: BSD-3-Clause Imports: 22 Imported by: 7

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/cyverse/go-irodsclient

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddChildToResc(conn *connection.IRODSConnection, parent string, child string, options string) error
func AddCollectionMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error
func AddDataObjectMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error
func AddGroupMember(conn *connection.IRODSConnection, groupname string, username string, ...) error
func AddResourceMeta(conn *connection.IRODSConnection, name string, metadata *types.IRODSMeta) error
func AddTicketAllowedGroup(conn *connection.IRODSConnection, ticketName string, groupName string) error
func AddTicketAllowedHost(conn *connection.IRODSConnection, ticketName string, host string) error
func AddTicketAllowedUser(conn *connection.IRODSConnection, ticketName string, userName string) error
func AddUserMeta(conn *connection.IRODSConnection, user string, metadata *types.IRODSMeta) error
func ChangeCollectionAccess(conn *connection.IRODSConnection, path string, ...) error
func ChangeDataObjectAccess(conn *connection.IRODSConnection, path string, ...) error
func ChangeUserPassword(conn *connection.IRODSConnection, username string, zone string, ...) error
func ChangeUserType(conn *connection.IRODSConnection, username string, zone string, newType string) error
func ClearTicketExpirationTime(conn *connection.IRODSConnection, ticketName string) error
func ClearTicketUseLimit(conn *connection.IRODSConnection, ticketName string) error
func ClearTicketWriteByteLimit(conn *connection.IRODSConnection, ticketName string) error
func ClearTicketWriteFileLimit(conn *connection.IRODSConnection, ticketName string) error
func CloseDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) error
func CloseDataObjectReplica(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) error
func CompleteDataObjectRedirection(conn *connection.IRODSConnection, handle *types.IRODSFileOpenRedirectionHandle) error
func CopyDataObject(conn *connection.IRODSConnection, srcPath string, destPath string, force bool) error
func CreateCollection(conn *connection.IRODSConnection, path string, recurse bool) error
func CreateDataObject(conn *connection.IRODSConnection, path string, resource string, mode string, ...) (*types.IRODSFileHandle, error)
func CreateGroup(conn *connection.IRODSConnection, groupname string, groupType string) error
func CreateTicket(conn *connection.IRODSConnection, ticketName string, ...) error
func CreateUser(conn *connection.IRODSConnection, username string, zone string, ...) error
func DeleteCollection(conn *connection.IRODSConnection, path string, recurse bool, force bool) error
func DeleteCollectionMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error
func DeleteDataObject(conn *connection.IRODSConnection, path string, force bool) error
func DeleteDataObjectMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error
func DeleteResourceMeta(conn *connection.IRODSConnection, name string, metadata *types.IRODSMeta) error
func DeleteTicket(conn *connection.IRODSConnection, ticketName string) error
func DeleteUserMeta(conn *connection.IRODSConnection, user string, metadata *types.IRODSMeta) error
func DownloadDataObject(session *session.IRODSSession, irodsPath string, resource string, ...) error
func DownloadDataObjectFromResourceServer(session *session.IRODSSession, irodsPath string, resource string, ...) error
func DownloadDataObjectParallel(session *session.IRODSSession, irodsPath string, resource string, ...) error
func DownloadDataObjectParallelResumable(session *session.IRODSSession, irodsPath string, resource string, ...) error
func DownloadDataObjectResumable(session *session.IRODSSession, irodsPath string, resource string, ...) error
func DownloadDataObjectToBuffer(session *session.IRODSSession, irodsPath string, resource string, ...) error
func ExtractStructFile(conn *connection.IRODSConnection, path string, target string, resource string, ...) error
func GetCollection(conn *connection.IRODSConnection, path string) (*types.IRODSCollection, error)
func GetDataObject(conn *connection.IRODSConnection, collection *types.IRODSCollection, ...) (*types.IRODSDataObject, error)
func GetDataObjectChecksum(conn *connection.IRODSConnection, path string, resource string) (*types.IRODSChecksum, error)
func GetDataObjectMasterReplica(conn *connection.IRODSConnection, collection *types.IRODSCollection, ...) (*types.IRODSDataObject, error)
func GetDataObjectRedirectionInfoForGet(conn *connection.IRODSConnection, path string, resource string, ...) (*types.IRODSFileOpenRedirectionHandle, error)
func GetDataObjectRedirectionInfoForPut(conn *connection.IRODSConnection, path string, resource string, ...) (*types.IRODSFileOpenRedirectionHandle, error)
func GetDataObjectTransferStatusFilePath(p string) string
func GetGroup(conn *connection.IRODSConnection, group string) (*types.IRODSUser, error)
func GetLockDataObject(conn *connection.IRODSConnection, path string) (*types.IRODSFileLockHandle, error)
func GetReplicaAccessInfo(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) (string, string, error)
func GetResource(conn *connection.IRODSConnection, name string) (*types.IRODSResource, error)
func GetTicket(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)
func GetTicketForAnonymousAccess(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicketForAnonymousAccess, error)
func GetTicketForCollections(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)
func GetTicketForDataObjects(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)
func GetUserGlobalQuota(conn *connection.IRODSConnection, user string) (*types.IRODSQuota, error)
func IsDataObjectTransferStatusFile(p string) bool
func ListAccessesForDataObjects(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSAccess, error)
func ListAccessesForSubCollections(conn *connection.IRODSConnection, path string) ([]*types.IRODSAccess, error)
func ListCollectionAccesses(conn *connection.IRODSConnection, path string) ([]*types.IRODSAccess, error)
func ListCollectionMeta(conn *connection.IRODSConnection, path string) ([]*types.IRODSMeta, error)
func ListDataObjectAccesses(conn *connection.IRODSConnection, collection *types.IRODSCollection, ...) ([]*types.IRODSAccess, error)
func ListDataObjectMeta(conn *connection.IRODSConnection, collection *types.IRODSCollection, ...) ([]*types.IRODSMeta, error)
func ListDataObjects(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSDataObject, error)
func ListDataObjectsMasterReplica(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSDataObject, error)
func ListGroupUsers(conn *connection.IRODSConnection, group string) ([]*types.IRODSUser, error)
func ListGroups(conn *connection.IRODSConnection) ([]*types.IRODSUser, error)
func ListResourceMeta(conn *connection.IRODSConnection, name string) ([]*types.IRODSMeta, error)
func ListSubCollections(conn *connection.IRODSConnection, path string) ([]*types.IRODSCollection, error)
func ListTicketAllowedGroupNames(conn *connection.IRODSConnection, ticketID int64) ([]string, error)
func ListTicketAllowedHosts(conn *connection.IRODSConnection, ticketID int64) ([]string, error)
func ListTicketAllowedUserNames(conn *connection.IRODSConnection, ticketID int64) ([]string, error)
func ListTickets(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)
func ListTicketsBasic(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)
func ListTicketsForCollections(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)
func ListTicketsForDataObjects(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)
func ListUserGroupNames(conn *connection.IRODSConnection, user string) ([]string, error)
func ListUserMeta(conn *connection.IRODSConnection, user string) ([]*types.IRODSMeta, error)
func ListUserResourceQuota(conn *connection.IRODSConnection, user string) ([]*types.IRODSQuota, error)
func ListUsers(conn *connection.IRODSConnection) ([]*types.IRODSUser, error)
func LockDataObject(conn *connection.IRODSConnection, path string, ...) (*types.IRODSFileLockHandle, error)
func ModifyTicket(conn *connection.IRODSConnection, ticketName string, args ...string) error
func ModifyTicketExpirationTime(conn *connection.IRODSConnection, ticketName string, expirationTime time.Time) error
func ModifyTicketUseLimit(conn *connection.IRODSConnection, ticketName string, uses int64) error
func ModifyTicketWriteByteLimit(conn *connection.IRODSConnection, ticketName string, bytes int64) error
func ModifyTicketWriteFileLimit(conn *connection.IRODSConnection, ticketName string, count int64) error
func MoveCollection(conn *connection.IRODSConnection, srcPath string, destPath string) error
func MoveDataObject(conn *connection.IRODSConnection, srcPath string, destPath string) error
func OpenDataObject(conn *connection.IRODSConnection, path string, resource string, mode string) (*types.IRODSFileHandle, int64, error)
func OpenDataObjectForPutParallel(conn *connection.IRODSConnection, path string, resource string, mode string, ...) (*types.IRODSFileHandle, error)
func OpenDataObjectWithOperation(conn *connection.IRODSConnection, path string, resource string, mode string, ...) (*types.IRODSFileHandle, error)
func OpenDataObjectWithReplicaToken(conn *connection.IRODSConnection, path string, resource string, mode string, ...) (*types.IRODSFileHandle, int64, error)
func ReadDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, buffer []byte) (int, error)
func ReadDataObjectWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, buffer []byte, ...) (int, error)
func RemoveGroupMember(conn *connection.IRODSConnection, groupname string, username string, ...) error
func RemoveTicketAllowedGroup(conn *connection.IRODSConnection, ticketName string, groupName string) error
func RemoveTicketAllowedHost(conn *connection.IRODSConnection, ticketName string, host string) error
func RemoveTicketAllowedUser(conn *connection.IRODSConnection, ticketName string, userName string) error
func RemoveUser(conn *connection.IRODSConnection, username string, zone string) error
func ReplicateDataObject(conn *connection.IRODSConnection, path string, resource string, update bool, ...) error
func SearchCollectionsByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSCollection, error)
func SearchCollectionsByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSCollection, error)
func SearchDataObjectsByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)
func SearchDataObjectsByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)
func SearchDataObjectsMasterReplicaByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)
func SearchDataObjectsMasterReplicaByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)
func SeekDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, offset int64, ...) (int64, error)
func SetAccessInherit(conn *connection.IRODSConnection, path string, ...) error
func SetGroupQuota(conn *connection.IRODSConnection, group string, resource string, value string) error
func SetUserQuota(conn *connection.IRODSConnection, user string, resource string, value string) error
func StatProcess(conn *connection.IRODSConnection, address string, zone string) ([]*types.IRODSProcess, error)
func SupplyTicket(conn *connection.IRODSConnection, ticketName string) error
func TrimDataObject(conn *connection.IRODSConnection, path string, resource string, minCopies int, ...) error
func TruncateDataObject(conn *connection.IRODSConnection, path string, size int64) error
func TruncateDataObjectHandle(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, size int64) error
func UnlockDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileLockHandle) error
func UploadDataObject(session *session.IRODSSession, localPath string, irodsPath string, ...) error
func UploadDataObjectFromBuffer(session *session.IRODSSession, buffer bytes.Buffer, irodsPath string, ...) error
func UploadDataObjectParallel(session *session.IRODSSession, localPath string, irodsPath string, ...) error
func UploadDataObjectToResourceServer(session *session.IRODSSession, localPath string, irodsPath string, ...) error
func WriteDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, data []byte) error
func WriteDataObjectAsyncWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, ...) error
func WriteDataObjectWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, data []byte, ...) error
type DataObjectTransferStatus
- func NewDataObjectTransferStatus(path string, size int64, threads int) *DataObjectTransferStatus
- func (status *DataObjectTransferStatus) Validate(path string, size int64) bool
type DataObjectTransferStatusEntry
type DataObjectTransferStatusLocal
- func GetDataObjectTransferStatusLocal(localPath string) (*DataObjectTransferStatusLocal, error)
- func GetOrNewDataObjectTransferStatusLocal(localPath string, size int64, threads int) (*DataObjectTransferStatusLocal, error)
- func NewDataObjectTransferStatusLocal(localPath string, size int64, threads int) *DataObjectTransferStatusLocal
- func (status *DataObjectTransferStatusLocal) CloseStatusFile() error
- func (status *DataObjectTransferStatusLocal) CreateStatusFile() error
- func (status *DataObjectTransferStatusLocal) DeleteStatusFile() error
- func (status *DataObjectTransferStatusLocal) GetStatus() *DataObjectTransferStatus
- func (status *DataObjectTransferStatusLocal) WriteHeader() error
- func (status *DataObjectTransferStatusLocal) WriteStatus(entry *DataObjectTransferStatusEntry) error

Constants ¶

View Source

const (
	DataObjectTransferStatusFilePrefix string = ".grc."
	DataObjectTransferStatusFileSuffix string = ".trx_status"
)

Variables ¶

This section is empty.

Functions ¶

func AddChildToResc ¶ added in v0.4.4

func AddChildToResc(conn *connection.IRODSConnection, parent string, child string, options string) error

AddChildToResc adds a child to a parent resource

func AddCollectionMeta ¶ added in v0.2.0

func AddCollectionMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error

AddCollectionMeta sets metadata of a data object for the path to the given key values. metadata.AVUID is ignored

func AddDataObjectMeta ¶ added in v0.2.0

func AddDataObjectMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error

AddDataObjectMeta sets metadata of a data object for the path to the given key values. metadata.AVUID is ignored

func AddGroupMember ¶ added in v0.10.0

func AddGroupMember(conn *connection.IRODSConnection, groupname string, username string, zone string) error

AddGroupMember adds a user to a group.

func AddResourceMeta ¶ added in v0.4.0

func AddResourceMeta(conn *connection.IRODSConnection, name string, metadata *types.IRODSMeta) error

AddResourceMeta sets metadata of a resource to the given key values. metadata.AVUID is ignored

func AddTicketAllowedGroup ¶ added in v0.12.0

func AddTicketAllowedGroup(conn *connection.IRODSConnection, ticketName string, groupName string) error

AddTicketAllowedGroup adds a group to the allowed group names list of the given ticket

func AddTicketAllowedHost ¶ added in v0.12.0

func AddTicketAllowedHost(conn *connection.IRODSConnection, ticketName string, host string) error

AddTicketAllowedHost adds a host to the allowed hosts list of the given ticket

func AddTicketAllowedUser ¶ added in v0.12.0

func AddTicketAllowedUser(conn *connection.IRODSConnection, ticketName string, userName string) error

AddTicketAllowedUser adds a user to the allowed user names list of the given ticket

func AddUserMeta ¶ added in v0.4.5

func AddUserMeta(conn *connection.IRODSConnection, user string, metadata *types.IRODSMeta) error

AddUserMeta sets metadata of a user object to given key values.

func ChangeCollectionAccess ¶ added in v0.9.4

func ChangeCollectionAccess(conn *connection.IRODSConnection, path string, access types.IRODSAccessLevelType, userName, zoneName string, recursive bool, adminFlag bool) error

ChangeCollectionAccess changes access on a collection.

func ChangeDataObjectAccess ¶ added in v0.9.4

func ChangeDataObjectAccess(conn *connection.IRODSConnection, path string, access types.IRODSAccessLevelType, userName, zoneName string, adminFlag bool) error

ChangeDataObjectAccess changes access control on a data object.

func ChangeUserPassword ¶ added in v0.10.0

func ChangeUserPassword(conn *connection.IRODSConnection, username string, zone string, newPassword string) error

ChangeUserPassword changes the password of a user object

func ChangeUserType ¶ added in v0.4.5

func ChangeUserType(conn *connection.IRODSConnection, username string, zone string, newType string) error

ChangeUserType changes the type / role of a user object

func ClearTicketExpirationTime ¶ added in v0.12.0

func ClearTicketExpirationTime(conn *connection.IRODSConnection, ticketName string) error

ClearTicketExpirationTime clears the expiration time of the given ticket

func ClearTicketUseLimit ¶ added in v0.12.0

func ClearTicketUseLimit(conn *connection.IRODSConnection, ticketName string) error

ClearTicketUseLimit clears the use limit of the given ticket

func ClearTicketWriteByteLimit ¶ added in v0.12.0

func ClearTicketWriteByteLimit(conn *connection.IRODSConnection, ticketName string) error

ClearTicketWriteByteLimit clears the write byte limit of the given ticket

func ClearTicketWriteFileLimit ¶ added in v0.12.0

func ClearTicketWriteFileLimit(conn *connection.IRODSConnection, ticketName string) error

ClearTicketWriteFileLimit clears the write file limit of the given ticket

func CloseDataObject ¶

func CloseDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) error

CloseDataObject closes a file handle of a data object

func CloseDataObjectReplica ¶ added in v0.5.2

func CloseDataObjectReplica(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) error

CloseDataObjectReplica closes a file handle of a data object replica, only used by parallel upload

func CompleteDataObjectRedirection ¶ added in v0.14.0

func CompleteDataObjectRedirection(conn *connection.IRODSConnection, handle *types.IRODSFileOpenRedirectionHandle) error

CompleteDataObjectRedirection completes a redirection for accessing the data object for downloading and uploading

func CopyDataObject ¶

func CopyDataObject(conn *connection.IRODSConnection, srcPath string, destPath string, force bool) error

CopyDataObject creates a copy of a data object for the path

func CreateCollection ¶

func CreateCollection(conn *connection.IRODSConnection, path string, recurse bool) error

CreateCollection creates a collection for the path

func CreateDataObject ¶

func CreateDataObject(conn *connection.IRODSConnection, path string, resource string, mode string, force bool) (*types.IRODSFileHandle, error)

CreateDataObject creates a data object for the path, returns a file handle

func CreateGroup ¶ added in v0.10.0

func CreateGroup(conn *connection.IRODSConnection, groupname string, groupType string) error

CreateGroup creates a group.

func CreateTicket ¶ added in v0.12.0

func CreateTicket(conn *connection.IRODSConnection, ticketName string, ticketType types.TicketType, path string) error

CreateTicket creates a ticket

func CreateUser ¶ added in v0.10.0

func CreateUser(conn *connection.IRODSConnection, username string, zone string, userType string) error

CreateUser creates a user.

func DeleteCollection ¶

func DeleteCollection(conn *connection.IRODSConnection, path string, recurse bool, force bool) error

DeleteCollection deletes a collection for the path

func DeleteCollectionMeta ¶ added in v0.2.0

func DeleteCollectionMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error

DeleteCollectionMeta sets metadata of a data object for the path to the given key values. The metadata AVU is selected on basis of AVUID if it is supplied, otherwise on basis of Name, Value and Units.

func DeleteDataObject ¶

func DeleteDataObject(conn *connection.IRODSConnection, path string, force bool) error

DeleteDataObject deletes a data object for the path

func DeleteDataObjectMeta ¶ added in v0.2.0

func DeleteDataObjectMeta(conn *connection.IRODSConnection, path string, metadata *types.IRODSMeta) error

DeleteDataObjectMeta sets metadata of a data object for the path to the given key values. The metadata AVU is selected on basis of AVUID if it is supplied, otherwise on basis of Name, Value and Units.

func DeleteResourceMeta ¶ added in v0.4.0

func DeleteResourceMeta(conn *connection.IRODSConnection, name string, metadata *types.IRODSMeta) error

DeleteResourceMeta sets metadata of a resource to the given key values. The metadata AVU is selected on basis of AVUID if it is supplied, otherwise on basis of Name, Value and Units.

func DeleteTicket ¶ added in v0.12.0

func DeleteTicket(conn *connection.IRODSConnection, ticketName string) error

DeleteTicket deletes the ticket

func DeleteUserMeta ¶ added in v0.4.5

func DeleteUserMeta(conn *connection.IRODSConnection, user string, metadata *types.IRODSMeta) error

DeleteUserMeta removes the metadata of a user object. The metadata AVU is selected on basis of AVUID if it is supplied, otherwise on basis of Name, Value and Units.

func DownloadDataObject ¶

func DownloadDataObject(session *session.IRODSSession, irodsPath string, resource string, localPath string, fileLength int64, callback common.TrackerCallBack) error

DownloadDataObject downloads a data object at the iRODS path to the local path

func DownloadDataObjectFromResourceServer ¶ added in v0.14.0

func DownloadDataObjectFromResourceServer(session *session.IRODSSession, irodsPath string, resource string, localPath string, fileLength int64, callback common.TrackerCallBack) error

DownloadDataObjectFromResourceServer downloads a data object at the iRODS path to the local path

func DownloadDataObjectParallel ¶ added in v0.5.2

func DownloadDataObjectParallel(session *session.IRODSSession, irodsPath string, resource string, localPath string, fileLength int64, taskNum int, callback common.TrackerCallBack) error

DownloadDataObjectParallel downloads a data object at the iRODS path to the local path in parallel Partitions a file into n (taskNum) tasks and downloads in parallel

func DownloadDataObjectParallelResumable ¶ added in v0.12.20

func DownloadDataObjectParallelResumable(session *session.IRODSSession, irodsPath string, resource string, localPath string, fileLength int64, taskNum int, callback common.TrackerCallBack) error

DownloadDataObjectParallelResumable downloads a data object at the iRODS path to the local path in parallel with support of transfer resume Partitions a file into n (taskNum) tasks and downloads in parallel

func DownloadDataObjectResumable ¶ added in v0.12.20

func DownloadDataObjectResumable(session *session.IRODSSession, irodsPath string, resource string, localPath string, fileLength int64, callback common.TrackerCallBack) error

DownloadDataObjectResumable downloads a data object at the iRODS path to the local path with support of transfer resume

func DownloadDataObjectToBuffer ¶ added in v0.12.8

func DownloadDataObjectToBuffer(session *session.IRODSSession, irodsPath string, resource string, buffer bytes.Buffer, dataObjectLength int64, callback common.TrackerCallBack) error

DownloadDataObjectToBuffer downloads a data object at the iRODS path to buffer

func ExtractStructFile ¶ added in v0.9.4

func ExtractStructFile(conn *connection.IRODSConnection, path string, target string, resource string, dataType types.DataType, force bool, bulkReg bool) error

ExtractStructFile extracts a struct file for the path

func GetCollection ¶

func GetCollection(conn *connection.IRODSConnection, path string) (*types.IRODSCollection, error)

GetCollection returns a collection for the path

func GetDataObject ¶

func GetDataObject(conn *connection.IRODSConnection, collection *types.IRODSCollection, filename string) (*types.IRODSDataObject, error)

GetDataObject returns a data object for the path

func GetDataObjectChecksum ¶ added in v0.12.6

func GetDataObjectChecksum(conn *connection.IRODSConnection, path string, resource string) (*types.IRODSChecksum, error)

GetDataObjectChecksum returns a data object checksum for the path

func GetDataObjectMasterReplica ¶

func GetDataObjectMasterReplica(conn *connection.IRODSConnection, collection *types.IRODSCollection, filename string) (*types.IRODSDataObject, error)

GetDataObjectMasterReplica returns a data object for the path, returns only master replica

func GetDataObjectRedirectionInfoForGet ¶ added in v0.14.0

func GetDataObjectRedirectionInfoForGet(conn *connection.IRODSConnection, path string, resource string, fileLength int64) (*types.IRODSFileOpenRedirectionHandle, error)

GetDataObjectRedirectionInfoForGet returns a redirection info for accessing the data object for downloading

func GetDataObjectRedirectionInfoForPut ¶ added in v0.14.0

func GetDataObjectRedirectionInfoForPut(conn *connection.IRODSConnection, path string, resource string, fileLength int64) (*types.IRODSFileOpenRedirectionHandle, error)

GetDataObjectRedirectionInfoForPut returns a redirection info for accessing the data object for uploading

func GetDataObjectTransferStatusFilePath ¶ added in v0.12.20

func GetDataObjectTransferStatusFilePath(p string) string

GetDataObjectTransferStatusFilePath returns transfer status file path

func GetGroup ¶ added in v0.3.0

func GetGroup(conn *connection.IRODSConnection, group string) (*types.IRODSUser, error)

GetGroup returns the group

func GetLockDataObject ¶ added in v0.12.8

func GetLockDataObject(conn *connection.IRODSConnection, path string) (*types.IRODSFileLockHandle, error)

GetLockDataObject returns a data object lock for the path, returns a file lock handle

func GetReplicaAccessInfo ¶ added in v0.5.2

func GetReplicaAccessInfo(conn *connection.IRODSConnection, handle *types.IRODSFileHandle) (string, string, error)

GetReplicaAccessInfo returns replica token and resource hierarchy

func GetResource ¶ added in v0.4.0

func GetResource(conn *connection.IRODSConnection, name string) (*types.IRODSResource, error)

GetResource returns a resource for the name

func GetTicket ¶ added in v0.12.1

func GetTicket(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)

GetTicket returns the ticket

func GetTicketForAnonymousAccess ¶ added in v0.7.0

func GetTicketForAnonymousAccess(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicketForAnonymousAccess, error)

https://github.com/irods/irods_client_s3_ticketbooth/blob/b92e8aaa3127cb56fcb8fef09caa00244bd29ca6/ticket_booth/main.py GetTicketForAnonymousAccess returns minimal ticket information for the ticket name string

func GetTicketForCollections ¶ added in v0.12.1

func GetTicketForCollections(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)

GetTicketForCollections returns ticket information for the ticket name string

func GetTicketForDataObjects ¶ added in v0.12.1

func GetTicketForDataObjects(conn *connection.IRODSConnection, ticketName string) (*types.IRODSTicket, error)

GetTicketForDataObjects returns ticket information for the ticket name string

func GetUserGlobalQuota ¶ added in v0.5.1

func GetUserGlobalQuota(conn *connection.IRODSConnection, user string) (*types.IRODSQuota, error)

GetUserGlobalQuota returns the global quota of a user or group

func IsDataObjectTransferStatusFile ¶ added in v0.12.20

func IsDataObjectTransferStatusFile(p string) bool

IsDataObjectTransferStatusFile checks if the file is transfer status file

func ListAccessesForDataObjects ¶ added in v0.9.4

func ListAccessesForDataObjects(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSAccess, error)

ListAccessesForDataObjects returns data object accesses for data objects in the given path

func ListAccessesForSubCollections ¶ added in v0.9.4

func ListAccessesForSubCollections(conn *connection.IRODSConnection, path string) ([]*types.IRODSAccess, error)

ListAccessesForSubCollections returns collection accesses for subcollections in the given path

func ListCollectionAccesses ¶ added in v0.9.4

func ListCollectionAccesses(conn *connection.IRODSConnection, path string) ([]*types.IRODSAccess, error)

ListCollectionAccesses returns collection accesses for the path

func ListCollectionMeta ¶ added in v0.3.0

func ListCollectionMeta(conn *connection.IRODSConnection, path string) ([]*types.IRODSMeta, error)

ListCollectionMeta returns a colleciton metadata for the path

func ListDataObjectAccesses ¶ added in v0.9.4

func ListDataObjectAccesses(conn *connection.IRODSConnection, collection *types.IRODSCollection, filename string) ([]*types.IRODSAccess, error)

ListDataObjectAccesses returns data object accesses for the path

func ListDataObjectMeta ¶ added in v0.3.0

func ListDataObjectMeta(conn *connection.IRODSConnection, collection *types.IRODSCollection, filename string) ([]*types.IRODSMeta, error)

ListDataObjectMeta returns a data object metadata for the path

func ListDataObjects ¶

func ListDataObjects(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSDataObject, error)

ListDataObjects lists data objects in the given collection

func ListDataObjectsMasterReplica ¶

func ListDataObjectsMasterReplica(conn *connection.IRODSConnection, collection *types.IRODSCollection) ([]*types.IRODSDataObject, error)

ListDataObjectsMasterReplica lists data objects in the given collection, returns only master replica

func ListGroupUsers ¶ added in v0.3.0

func ListGroupUsers(conn *connection.IRODSConnection, group string) ([]*types.IRODSUser, error)

ListGroupUsers returns users in the group

func ListGroups ¶ added in v0.4.5

func ListGroups(conn *connection.IRODSConnection) ([]*types.IRODSUser, error)

ListGroups returns all groups

func ListResourceMeta ¶ added in v0.14.4

func ListResourceMeta(conn *connection.IRODSConnection, name string) ([]*types.IRODSMeta, error)

ListResourceMeta returns all metadata for the resource

func ListSubCollections ¶

func ListSubCollections(conn *connection.IRODSConnection, path string) ([]*types.IRODSCollection, error)

ListSubCollections lists subcollections in the given collection

func ListTicketAllowedGroupNames ¶ added in v0.12.0

func ListTicketAllowedGroupNames(conn *connection.IRODSConnection, ticketID int64) ([]string, error)

ListTicketAllowedGroupNames returns allowed group names for the given ticket

func ListTicketAllowedHosts ¶ added in v0.12.0

func ListTicketAllowedHosts(conn *connection.IRODSConnection, ticketID int64) ([]string, error)

ListTicketAllowedHosts returns allowed hosts for the given ticket

func ListTicketAllowedUserNames ¶ added in v0.12.0

func ListTicketAllowedUserNames(conn *connection.IRODSConnection, ticketID int64) ([]string, error)

ListTicketAllowedUserNames returns allowed user names for the given ticket

func ListTickets ¶ added in v0.12.0

func ListTickets(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)

ListTickets returns tickets

func ListTicketsBasic ¶ added in v0.12.0

func ListTicketsBasic(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)

ListTicketsBasic returns tickets with basic info

func ListTicketsForCollections ¶ added in v0.12.0

func ListTicketsForCollections(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)

ListTicketsForCollections returns tickets for collections

func ListTicketsForDataObjects ¶ added in v0.12.0

func ListTicketsForDataObjects(conn *connection.IRODSConnection) ([]*types.IRODSTicket, error)

ListTicketsForDataObjects returns tickets for data objects

func ListUserGroupNames ¶ added in v0.4.5

func ListUserGroupNames(conn *connection.IRODSConnection, user string) ([]string, error)

ListUserGroupNames lists the group names a user is a member of

func ListUserMeta ¶ added in v0.4.5

func ListUserMeta(conn *connection.IRODSConnection, user string) ([]*types.IRODSMeta, error)

ListUserMeta returns all metadata for the user

func ListUserResourceQuota ¶ added in v0.4.5

func ListUserResourceQuota(conn *connection.IRODSConnection, user string) ([]*types.IRODSQuota, error)

ListUserResourceQuota lists all existing resource quota of a user or group

func ListUsers ¶ added in v0.4.5

func ListUsers(conn *connection.IRODSConnection) ([]*types.IRODSUser, error)

ListUsers lists all users

func LockDataObject ¶ added in v0.12.8

func LockDataObject(conn *connection.IRODSConnection, path string, lockType types.DataObjectLockType, lockCommand types.DataObjectLockCommand) (*types.IRODSFileLockHandle, error)

LockDataObject locks a data object for the path, returns a file lock handle

func ModifyTicket ¶ added in v0.12.0

func ModifyTicket(conn *connection.IRODSConnection, ticketName string, args ...string) error

ModifyTicket modifies the given ticket

func ModifyTicketExpirationTime ¶ added in v0.12.0

func ModifyTicketExpirationTime(conn *connection.IRODSConnection, ticketName string, expirationTime time.Time) error

ModifyTicketExpirationTime modifies the expiration time of the given ticket

func ModifyTicketUseLimit ¶ added in v0.12.0

func ModifyTicketUseLimit(conn *connection.IRODSConnection, ticketName string, uses int64) error

ModifyTicketUseLimit modifies the use limit of the given ticket

func ModifyTicketWriteByteLimit ¶ added in v0.12.0

func ModifyTicketWriteByteLimit(conn *connection.IRODSConnection, ticketName string, bytes int64) error

ModifyTicketWriteByteLimit modifies the write byte limit of the given ticket

func ModifyTicketWriteFileLimit ¶ added in v0.12.0

func ModifyTicketWriteFileLimit(conn *connection.IRODSConnection, ticketName string, count int64) error

ModifyTicketWriteFileLimit modifies the write file limit of the given ticket

func MoveCollection ¶

func MoveCollection(conn *connection.IRODSConnection, srcPath string, destPath string) error

MoveCollection moves a collection for the path to another path

func MoveDataObject ¶

func MoveDataObject(conn *connection.IRODSConnection, srcPath string, destPath string) error

MoveDataObject moves a data object for the path to another path

func OpenDataObject ¶

func OpenDataObject(conn *connection.IRODSConnection, path string, resource string, mode string) (*types.IRODSFileHandle, int64, error)

OpenDataObject opens a data object for the path, returns a file handle

func OpenDataObjectForPutParallel ¶ added in v0.12.5

func OpenDataObjectForPutParallel(conn *connection.IRODSConnection, path string, resource string, mode string, oper common.OperationType, threadNum int, dataSize int64) (*types.IRODSFileHandle, error)

OpenDataObjectForPutParallel opens a data object for the path, returns a file handle

func OpenDataObjectWithOperation ¶

func OpenDataObjectWithOperation(conn *connection.IRODSConnection, path string, resource string, mode string, oper common.OperationType) (*types.IRODSFileHandle, error)

OpenDataObjectWithOperation opens a data object for the path, returns a file handle

func OpenDataObjectWithReplicaToken ¶ added in v0.5.2

func OpenDataObjectWithReplicaToken(conn *connection.IRODSConnection, path string, resource string, mode string, replicaToken string, resourceHierarchy string, threadNum int, dataSize int64) (*types.IRODSFileHandle, int64, error)

OpenDataObjectWithReplicaToken opens a data object for the path, returns a file handle

func ReadDataObject ¶

func ReadDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, buffer []byte) (int, error)

ReadDataObject reads data from a data object

func ReadDataObjectWithTrackerCallBack ¶ added in v0.10.8

func ReadDataObjectWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, buffer []byte, callback common.TrackerCallBack) (int, error)

ReadDataObjectWithTrackerCallBack reads data from a data object

func RemoveGroupMember ¶ added in v0.10.0

func RemoveGroupMember(conn *connection.IRODSConnection, groupname string, username string, zone string) error

RemoveGroupMember removes a user from a group.

func RemoveTicketAllowedGroup ¶ added in v0.12.0

func RemoveTicketAllowedGroup(conn *connection.IRODSConnection, ticketName string, groupName string) error

RemoveTicketAllowedGroup removes the group from the allowed group names list of the given ticket

func RemoveTicketAllowedHost ¶ added in v0.12.0

func RemoveTicketAllowedHost(conn *connection.IRODSConnection, ticketName string, host string) error

RemoveTicketAllowedHost removes the host from the allowed hosts list of the given ticket

func RemoveTicketAllowedUser ¶ added in v0.12.0

func RemoveTicketAllowedUser(conn *connection.IRODSConnection, ticketName string, userName string) error

RemoveTicketAllowedUser removes the user from the allowed user names list of the given ticket

func RemoveUser ¶ added in v0.10.0

func RemoveUser(conn *connection.IRODSConnection, username string, zone string) error

RemoveUser removes a user or a group.

func ReplicateDataObject ¶

func ReplicateDataObject(conn *connection.IRODSConnection, path string, resource string, update bool, adminFlag bool) error

ReplicateDataObject replicates a data object for the path to the given reousrce

func SearchCollectionsByMeta ¶ added in v0.4.2

func SearchCollectionsByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSCollection, error)

SearchCollectionsByMeta searches collections by metadata

func SearchCollectionsByMetaWildcard ¶ added in v0.4.2

func SearchCollectionsByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSCollection, error)

SearchCollectionsByMetaWildcard searches collections by metadata Caution: This is a very slow operation

func SearchDataObjectsByMeta ¶ added in v0.4.2

func SearchDataObjectsByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)

SearchDataObjectsByMeta searches data objects by metadata

func SearchDataObjectsByMetaWildcard ¶ added in v0.4.2

func SearchDataObjectsByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)

SearchDataObjectsByMetaWildcard searches data objects by metadata Caution: This is a very slow operation

func SearchDataObjectsMasterReplicaByMeta ¶ added in v0.4.3

func SearchDataObjectsMasterReplicaByMeta(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)

SearchDataObjectsMasterReplicaByMeta searches data objects by metadata, returns only master replica

func SearchDataObjectsMasterReplicaByMetaWildcard ¶ added in v0.4.3

func SearchDataObjectsMasterReplicaByMetaWildcard(conn *connection.IRODSConnection, metaName string, metaValue string) ([]*types.IRODSDataObject, error)

SearchDataObjectsMasterReplicaByMetaWildcard searches data objects by metadata, returns only master replica Caution: This is a very slow operation

func SeekDataObject ¶

func SeekDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, offset int64, whence types.Whence) (int64, error)

SeekDataObject moves file pointer of a data object, returns offset

func SetAccessInherit ¶ added in v0.9.4

func SetAccessInherit(conn *connection.IRODSConnection, path string, inherit, recursive, adminFlag bool) error

SetAccessInherit sets the inherit bit on a collection.

func SetGroupQuota ¶ added in v0.4.5

func SetGroupQuota(conn *connection.IRODSConnection, group string, resource string, value string) error

SetGroupQuota sets quota for a given user and resource ('total' for global)

func SetUserQuota ¶ added in v0.4.5

func SetUserQuota(conn *connection.IRODSConnection, user string, resource string, value string) error

SetUserQuota sets quota for a given user and resource ('total' for global)

func StatProcess ¶ added in v0.9.7

func StatProcess(conn *connection.IRODSConnection, address string, zone string) ([]*types.IRODSProcess, error)

StatProcess stats processes.

func SupplyTicket ¶ added in v0.12.0

func SupplyTicket(conn *connection.IRODSConnection, ticketName string) error

SupplyTicket supplies a ticket to obtain access

func TrimDataObject ¶ added in v0.4.0

func TrimDataObject(conn *connection.IRODSConnection, path string, resource string, minCopies int, minAgeMinutes int, adminFlag bool) error

TrimDataObject trims replicas for a data object

func TruncateDataObject ¶

func TruncateDataObject(conn *connection.IRODSConnection, path string, size int64) error

TruncateDataObject truncates a data object for the path to the given size

func TruncateDataObjectHandle ¶ added in v0.7.0

func TruncateDataObjectHandle(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, size int64) error

TruncateDataObjectHandle truncates a data object to the given size

func UnlockDataObject ¶ added in v0.12.8

func UnlockDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileLockHandle) error

UnlockDataObject unlocks a file handle of a data object

func UploadDataObject ¶

func UploadDataObject(session *session.IRODSSession, localPath string, irodsPath string, resource string, replicate bool, callback common.TrackerCallBack) error

UploadDataObject put a data object at the local path to the iRODS path

func UploadDataObjectFromBuffer ¶ added in v0.12.8

func UploadDataObjectFromBuffer(session *session.IRODSSession, buffer bytes.Buffer, irodsPath string, resource string, replicate bool, callback common.TrackerCallBack) error

UploadDataObjectFromBuffer put a data object to the iRODS path from buffer

func UploadDataObjectParallel ¶ added in v0.5.2

func UploadDataObjectParallel(session *session.IRODSSession, localPath string, irodsPath string, resource string, taskNum int, replicate bool, callback common.TrackerCallBack) error

UploadDataObjectParallel put a data object at the local path to the iRODS path in parallel Partitions a file into n (taskNum) tasks and uploads in parallel

func UploadDataObjectToResourceServer ¶ added in v0.14.0

func UploadDataObjectToResourceServer(session *session.IRODSSession, localPath string, irodsPath string, resource string, replicate bool, callback common.TrackerCallBack) error

UploadDataObjectToResourceServer uploads a data object at the local path to the iRODS path

func WriteDataObject ¶

func WriteDataObject(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, data []byte) error

WriteDataObject writes data to a data object

func WriteDataObjectAsyncWithTrackerCallBack ¶ added in v0.11.4

func WriteDataObjectAsyncWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, dataReader io.Reader, totalDataSize int64, callback common.TrackerCallBack) error

WriteDataObjectAsyncWithTrackerCallBack writes data to a data object asynchronously

func WriteDataObjectWithTrackerCallBack ¶ added in v0.10.8

func WriteDataObjectWithTrackerCallBack(conn *connection.IRODSConnection, handle *types.IRODSFileHandle, data []byte, callback common.TrackerCallBack) error

WriteDataObjectWithTrackerCallBack writes data to a data object

Types ¶

type DataObjectTransferStatus ¶ added in v0.12.20

type DataObjectTransferStatus struct {
	Path           string                                   `json:"path"`
	StatusFilePath string                                   `json:"status_file_path"`
	Size           int64                                    `json:"size"`
	Threads        int                                      `json:"threads"`
	StatusMap      map[int64]*DataObjectTransferStatusEntry `json:"-"`
}

DataObjectTransferStatus represents data object transfer

func NewDataObjectTransferStatus ¶ added in v0.12.20

func NewDataObjectTransferStatus(path string, size int64, threads int) *DataObjectTransferStatus

NewDataObjectTransferStatus creates new DataObjectTransferStatus

func (*DataObjectTransferStatus) Validate ¶ added in v0.12.20

func (status *DataObjectTransferStatus) Validate(path string, size int64) bool

type DataObjectTransferStatusEntry ¶ added in v0.12.20

type DataObjectTransferStatusEntry struct {
	StartOffset     int64 `json:"start_offset"`
	Length          int64 `json:"length"`
	CompletedLength int64 `json:"completed_length"`
}

DataObjectTransferStatusEntry

type DataObjectTransferStatusLocal ¶ added in v0.12.20

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

func GetDataObjectTransferStatusLocal ¶ added in v0.12.20

func GetDataObjectTransferStatusLocal(localPath string) (*DataObjectTransferStatusLocal, error)

GetDataObjectTransferStatusLocal returns DataObjectTransferStatusLocal in local disk

func GetOrNewDataObjectTransferStatusLocal ¶ added in v0.12.20

func GetOrNewDataObjectTransferStatusLocal(localPath string, size int64, threads int) (*DataObjectTransferStatusLocal, error)

GetOrNewDataObjectTransferStatusLocal returns DataObjectTransferStatus in iRODS

func NewDataObjectTransferStatusLocal ¶ added in v0.12.20

func NewDataObjectTransferStatusLocal(localPath string, size int64, threads int) *DataObjectTransferStatusLocal

func (*DataObjectTransferStatusLocal) CloseStatusFile ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) CloseStatusFile() error

func (*DataObjectTransferStatusLocal) CreateStatusFile ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) CreateStatusFile() error

func (*DataObjectTransferStatusLocal) DeleteStatusFile ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) DeleteStatusFile() error

func (*DataObjectTransferStatusLocal) GetStatus ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) GetStatus() *DataObjectTransferStatus

func (*DataObjectTransferStatusLocal) WriteHeader ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) WriteHeader() error

func (*DataObjectTransferStatusLocal) WriteStatus ¶ added in v0.12.20

func (status *DataObjectTransferStatusLocal) WriteStatus(entry *DataObjectTransferStatusEntry) error

Source Files ¶

View all Source files

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