package
0.14.15
Repository: https://github.com/cyverse/go-irodsclient.git
Documentation: pkg.go.dev

# Functions

CreateIRODSAccount creates IRODSAccount.
CreateIRODSAccountForTicket creates IRODSAccount.
CreateIRODSAccountFromYAML creates IRODSAccount from YAML.
CreateIRODSChecksum creates IRODSChecksum from checksum string.
CreateIRODSProxyAccount creates IRODSAccount for proxy access.
CreateIRODSSSLConfig creates IRODSSSLConfig.
GetAuthScheme returns AuthScheme value from string.
GetChecksumAlgorithm returns checksum algorithm from string.
GetChecksumDigestSize returns checksum digest size.
GetCSNegotiationPolicy returns CSNegotiationPolicy value from string.
GetCSNegotiationRequire returns CSNegotiationRequire value from string.
GetEncryptionAlgorithm returns encryption algorithm from string.
No description provided by the author
GetIRODSErrorCode returns iRODS error code if the error is iRODSError.
GetIRODSMetaItemType gets the irods metadata item type from an object.
IsAuthError evaluates if the given error is authentication failure.
IsCollectionNotEmptyError evaluates if the given error is collection not empty error.
IsConnectionConfigError evaluates if the given error is connection config error.
IsConnectionError evaluates if the given error is connection error.
IsConnectionPoolFullError evaluates if the given error is connection full error.
IsFileAlreadyExistError checks if the given error is FileAlreadyExistError.
IsFileNotFoundError checks if the given error is FileNotFoundError.
IsIRODSError checks if the given error is IRODSError.
IsPermanantFailure returns if given error is permanant failure.
IsResourceServerConnectionConfigError evaluates if the given error is resource server connection config error.
IsTicketNotFoundError checks if the given error is TicketNotFoundError.
IsUserNotFoundError checks if the given error is UserNotFoundError.
MakeIRODSChecksumString makes iRODS checksum string.
NewAuthError creates an error for auth.
NewCollectionNotEmptyError creates an error for collection not empty.
NewConnectionConfigError creates a connection config error.
NewConnectionError creates an error for connection poll full.
NewConnectionPoolFullError creates an error for connection poll full.
NewFileAlreadyExistError creates an error for file already exist.
NewFileNotFoundError creates an error for file not found.
NewIRODSError creates a new IRODSError.
NewIRODSErrorWithString creates a new IRODSError with message.
NewResourceServerConnectionConfigError creates a resource server connection config error.
NewTicketNotFoundError creates an error for ticket not found.
NewUserNotFoundError creates an error for user not found.
ParseIRODSChecksumString parses iRODS checksum string.
PerformCSNegotiation performs CSNegotiation and returns the policy determined.

# Constants

No description provided by the author
No description provided by the author
*.z, *.zip, *.gz.
*.z, *.zip, *.gz.
*.txt.
No description provided by the author
AuthSchemeGSI uses GSI authentication scheme.
AuthSchemeNative uses Native authentication scheme.
AuthSchemePAM uses PAM authentication scheme.
AuthSchemeUnknown is unknown scheme.
*.avi.
No description provided by the author
*.bmp.
*.bz2.
No description provided by the author
*.tar.bz2.
*.c.
*.c.
ChecksumAlgorithmADLER32 is for ADLER32.
ChecksumAlgorithmMD5 is for MD5.
ChecksumAlgorithmSHA1 is for SHA1.
ChecksumAlgorithmSHA256 is for SHA256.
ChecksumAlgorithmSHA512 is for SHA512.
ChecksumAlgorithmUnknown is for unknown algorithm.
ColumnTypeDateTime is for datetime column.
ColumnTypeInteger is for integer column.
ColumnTypeString is for string column.
No description provided by the author
*.cif, *.mmcif.
*.pdb.
*.tz, *.tgz, *.zip.
No description provided by the author
No description provided by the author
CSNegotiationDontCare requires any of TCP or SSL connection.
CSNegotiationFailure presents negotiation is failed.
CSNegotiationRequireSSL requires SSL connection.
CSNegotiationRequireTCP requires Plain TCP connection.
CSNegotiationUseSSL uses SSL connection.
CSNegotiationUseTCP uses Plain TCP connection.
No description provided by the author
*.dat.
No description provided by the author
No description provided by the author
No description provided by the author
DataObjectLockCommandGetLock is for get lock command.
DataObjectLockCommandSetLock is for set lock command.
DataObjectLockCommandSetLockWait is for set lock wait command.
DataObjectLockTypeRead is for read lock.
DataObjectLockTypeWrite is for write lock.
DataObjectLockTypeWrite is for write lock.
No description provided by the author
No description provided by the author
*.IMA, *.ima.
No description provided by the author
No description provided by the author
No description provided by the author
*.dvi.
*.z, *.zip, *.gz.
*.z, *.zip, *.gz.
*.txt.
No description provided by the author
EncryptionAlgorithmAES256CBC is for AES-256-CBC.
EncryptionAlgorithmAES256CFB is for AES-256-CFB.
EncryptionAlgorithmAES256CTR is for AES-256-CTR.
EncryptionAlgorithmAES256OFB is for AES-256-OFB.
EncryptionAlgorithmDES256CBC is for DES-256-CBC.
EncryptionAlgorithmDES256CFB is for DES-256-CFB.
EncryptionAlgorithmDES256CTR is for DES-256-CTR.
EncryptionAlgorithmDES256OFB is for DES-256-OFB.
EncryptionAlgorithmUnknown is for unknown algorithm.
*.xls.
No description provided by the author
*.fig.
FileOpenModeAppend is for write, not trucate, but appends from the file end.
FileOpenModeReadAppend is for read and write, but appends from the file end.
FileOpenModeReadOnly is for read.
FileOpenModeReadWrite is for read and write.
FileOpenModeWriteOnly is for write.
FileOpenModeWriteTruncate is for write, but truncates the file.
*.fits, *.fit.
*.f.
No description provided by the author
*.gif.
*.gz.
No description provided by the author
*.tar.gz.
No description provided by the author
*.htm, *.html.
No description provided by the author
IRODSAccessLevelAdministerObject is for administer object access.
IRODSAccessLevelCreateMetadata is for create metadata access.
IRODSAccessLevelCreateObject is for create object access.
IRODSAccessLevelCreateToken is for create token access.
IRODSAccessLevelCurate is for curate access.
IRODSAccessLevelDeleteMetadata is for delete metadata access.
IRODSAccessLevelDeleteObject is for delete object access.
IRODSAccessLevelDeleteToken is for delete token access.
IRODSAccessLevelExecute is for execute access.
IRODSAccessLevelModifyMetadata is for modify metadata access.
IRODSAccessLevelModifyObject is for modify object access.
IRODSAccessLevelNull is for null access.
IRODSAccessLevelOwner is for owner access.
IRODSAccessLevelReadAnnotation is for read annotation access.
IRODSAccessLevelReadMetadata is for read metadata access.
IRODSAccessLevelReadObject is for read object access.
IRODSAccessLevelReadSystemMetadata is for read system metadata access.
IRODSAccessLevelWriteAnnotation is for write annotation access.
IRODSCollectionMetaItemType is a type for collection meta.
IRODSDataObjectMetaItemType is a type for data object meta.
IRODSResourceMetaItemType is a type for resource meta.
IRODSUserGroupAdmin is for an admin group.
IRODSUserMetaItemType is a type for user meta.
IRODSUserRodsAdmin is for an admin user.
IRODSUserRodsGroup is for a group.
IRODSUserRodsUser is for a user.
*.jav, *.java.
*.jpeg, *.jpg.
*.tex.
*.a.
*.o.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*.mp3, *.mpa.
*.mpeg, *.mpg.
*.mpeg, *.mpg.
*.mpeg, *.mpg.
No description provided by the author
No description provided by the author
*.doc, *.rtf.
No description provided by the author
No description provided by the author
No description provided by the author
O_APPEND is for append (moving the file pointer to the file end).
O_CREAT is for creating a file if not exists.
O_EXCL ...
O_RDONLY is for read.
O_RDWR is for read and write.
O_TRUNC is for truncating content.
O_WRONLY is for write.
*.o.
ObjectTypeCollection is for Collection.
ObjectTypeDataObject is for DataObject.
No description provided by the author
PamTTLDefault is a default value for Pam TTL.
*.pbm.
*.pdf.
*.pl.
*.png.
*.ps.
*.ppt.
No description provided by the author
No description provided by the author
*.mov.
*.ra.
*.rv.
SeekCur means offset starts from current offset.
SeekEnd means offset starts from file end.
SeekSet means offset starts from file start.
No description provided by the author
No description provided by the author
*.sgm, *.sgml.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*.sql.
No description provided by the author
No description provided by the author
*.tar.
*.tcl.
No description provided by the author
TicketTypeRead is for read.
TicketTypeWrite is for write.
*.tif, *.tiff.
*.trf, *.trof.
*.htm, *.html.
No description provided by the author
*.uu.
No description provided by the author
*.wav.
*.wmv.
*.doc, *.rtf.
*.xml.
*.xsd.
No description provided by the author
*.zip.

# Structs

AuthError contains auth error information.
CollectionNotEmptyError contains collection not empty error information.
ConnectionConfigError contains connection config error information.
ConnectionError contains connection error information.
ConnectionPoolFullError contains connection pool full error information.
FileAlreadyExistError contains file already exist error information.
FileNotFoundError contains file not found error information.
IRODSAccess contains irods access information.
IRODSAccessInheritance contains irods access inheritance information.
IRODSAccount contains irods login information.
IRODSChecksum contains data object hash information.
IRODSCollection contains irods collection information.
IRODSColumn is a struct holding a column.
IRODSDataObject contains irods data object information.
IRODSError contains irods error information.
IRODSFileHandle contains file handle.
IRODSFileLockHandle contains file lock handle.
IRODSFileOpenRedirectionHandle contains file open redirection handle.
IRODSMeta contains irods metadata.
IRODSProcess contains irods process information.
IRODSQuota describes a resource quota.
IRODSRedirectionInfo contains redirection info.
IRODSReplica contains irods data object replication information.
IRODSResource describes a resource host.
IRODSSSLConfig contains irods ssl configuration.
IRODSTicket contains irods ticket information.
IRODSTicketForAnonymousAccess contains minimal irods ticket information for anonymous access.
IRODSUser contains irods user information.
IRODSVersion contains irods version information.
IRODSZone contains irods zone information.
ResourceServerConnectionConfigError contains resource server connection config error information.
TicketNotFoundError contains ticket not found error information.
TransferDataBlock is a struct that maintains transfer data block info.
UserNotFoundError contains user/group not found error information.

# Type aliases

AuthScheme defines Authentication Scheme.
ChecksumAlgorithm determines checksum algorithm.
ColumnType is a type of iRODS Column.
CSNegotiationPolicy defines Negotiation result.
CSNegotiationRequire defines Negotiation request.
DataObjectLockCommand is a type for data object lock command.
DataObjectLockType is a type for data object lock type.
DataType is a type for data type.
EncryptionAlgorithm determines encryption algorithm.
FileOpenFlag is internally used value, derived from FileOpenMode.
FileOpenMode determines file open mode.
IRODSAccessLevelType is a type for access level.
IRODSMetaItemType describes a type to set metadata on.
IRODSUserType is a type of iRODS User.
ObjectType determines if the object is data object or collection in irods.
TicketType determines ticket access type.
Whence determines where to start counting the offset.