package
0.0.0-20230301072923-5e759bf089a0
Repository: https://github.com/truecloudlab/frostfs-sdk-go.git
Documentation: pkg.go.dev

# Packages

Package oid provides primitives to work with object identification in FrostFS.
Package relations provides feature to process inner object structure.
No description provided by the author

# Functions

CalculateAndSetID calculates identifier for the object and writes the result to it.
CalculateAndSetPayloadChecksum calculates checksum of current object payload and writes it to the object.
CalculateAndSetSignature signs id with provided key and sets that signature to the object.
CalculateID calculates identifier for the object.
CalculatePayloadChecksum calculates and returns checksum of object payload bytes.
CheckHeaderVerificationFields checks all verification fields except payload.
CheckVerificationFields checks all verification fields of the object.
InitCreation initializes the object instance with minimum set of required fields.
New creates and initializes blank Object.
NewAttribute creates and initializes blank Attribute.
NewAttributeFromV2 wraps v2 Attribute message to Attribute.
NewFromV2 wraps v2 Object message to Object.
NewRange creates and initializes blank Range.
NewRangeFromV2 wraps v2 Range message to Range.
NewRaw creates and initializes blank Object.
NewRawFrom wraps Object instance to Object.
NewRawFromV2 wraps v2 Object message to Object.
No description provided by the author
No description provided by the author
NewSplitID returns UUID representation of splitID attribute.
NewSplitIDFromV2 returns parsed UUID from bytes.
NewSplitInfo creates and initializes blank SplitInfo.
No description provided by the author
NewSplitInfoFromV2 wraps v2 SplitInfo message to SplitInfo.
NewTombstone creates and initializes blank Tombstone.
NewTombstoneFromV2 wraps v2 Tombstone message to Tombstone.
ReadLock reads Lock from the Object.
No description provided by the author
SetIDWithSignature sets object identifier and signature.
SetVerificationFields calculates and sets all verification fields of the object.
No description provided by the author
VerifyID checks if identifier in the object corresponds to its structure.
VerifyPayloadChecksum checks if payload checksum in the object corresponds to its payload.
WriteLock writes Lock to the Object, and sets its type to TypeLock.

# Constants

AttributeContentType is an attribute key that is commonly used to denote MIME Content Type of object's payload.
AttributeFileName is an attribute key that is commonly used to denote file name to be associated with the object on saving.
AttributeFilePath is an attribute key that is commonly used to denote full path to be associated with the object on saving.
AttributeName is an attribute key that is commonly used to denote human-friendly name.
AttributeTimestamp is an attribute key that is commonly used to denote user-defined local time of object creation in Unix Timestamp format.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

NotificationInfo groups information about object notification that can be written to object.
RequiredFields contains the minimum set of object data that must be set by the FrostFS user at the stage of creation.
No description provided by the author
SplitID is a UUIDv4 used as attribute in split objects.
No description provided by the author

# Type aliases

Attribute represents v2-compatible object attribute.
Lock represents record with locked objects.
Object represents in-memory structure of the FrostFS object.
Range represents v2-compatible object payload range.
RawObject represents v2-compatible FrostFS object that provides a convenient interface to fill in the fields of an object in isolation from its internal structure.
No description provided by the author
SearchMatchType indicates match operation on specified header.
No description provided by the author
Tombstone represents v2-compatible tombstone structure.
No description provided by the author