Documentation
¶
Index ¶
- Variables
- func IsErrNotFound(err error) bool
- func IterateAddresses(blz *Blobovnicza, f func(oid.Address) error) error
- type Blobovnicza
- func (b *Blobovnicza) Close() error
- func (b *Blobovnicza) Delete(prm DeletePrm) (DeleteRes, error)
- func (b *Blobovnicza) Exists(addr oid.Address) (bool, error)
- func (b *Blobovnicza) Get(prm GetPrm) (GetRes, error)
- func (b *Blobovnicza) Init() error
- func (b *Blobovnicza) Iterate(prm IteratePrm) (IterateRes, error)
- func (b *Blobovnicza) Open() error
- func (b *Blobovnicza) Put(prm PutPrm) (PutRes, error)
- type DeletePrm
- type DeleteRes
- type GetPrm
- type GetRes
- type ID
- type IteratePrm
- type IterateRes
- type IterationElement
- type IterationHandler
- type Option
- type PutPrm
- type PutRes
Constants ¶
This section is empty.
Variables ¶
var ErrFull = logicerr.New("blobovnicza is full")
ErrFull is returned when trying to save an object to a filled blobovnicza.
Functions ¶
func IsErrNotFound ¶
IsErrNotFound checks if the error returned by Blobovnicza Get/Delete method corresponds to the missing object.
func IterateAddresses ¶
func IterateAddresses(blz *Blobovnicza, f func(oid.Address) error) error
IterateAddresses is a helper function which iterates over Blobovnicza and passes addresses of the objects to f.
Types ¶
type Blobovnicza ¶
type Blobovnicza struct {
// contains filtered or unexported fields
}
Blobovnicza represents the implementation of FrostFS Blobovnicza.
func New ¶
func New(opts ...Option) *Blobovnicza
New creates and returns a new Blobovnicza instance.
func (*Blobovnicza) Close ¶
func (b *Blobovnicza) Close() error
Close releases all internal database resources.
func (*Blobovnicza) Delete ¶
func (b *Blobovnicza) Delete(prm DeletePrm) (DeleteRes, error)
Delete removes an object from Blobovnicza by address.
Returns any error encountered that did not allow to completely delete the object.
Returns an error of type apistatus.ObjectNotFound if the object to be deleted is not in blobovnicza.
Should not be called in read-only configuration.
func (*Blobovnicza) Exists ¶
func (b *Blobovnicza) Exists(addr oid.Address) (bool, error)
Exists check if object with the specified address is stored in b.
func (*Blobovnicza) Get ¶
func (b *Blobovnicza) Get(prm GetPrm) (GetRes, error)
Get reads an object from Blobovnicza by address.
Returns any error encountered that did not allow to completely read the object.
Returns an error of type apistatus.ObjectNotFound if the requested object is not presented in Blobovnicza.
func (*Blobovnicza) Init ¶
func (b *Blobovnicza) Init() error
Init initializes internal database structure.
If Blobovnicza is already initialized, no action is taken.
Should not be called in read-only configuration.
func (*Blobovnicza) Iterate ¶
func (b *Blobovnicza) Iterate(prm IteratePrm) (IterateRes, error)
Iterate goes through all stored objects, and passes IterationElement to parameterized handler until error return.
Decodes object addresses if DecodeAddresses was called. Don't read object data if WithoutData was called.
Returns handler's errors directly. Returns nil after iterating finish.
Handler should not retain object data. Handler must not be nil.
func (*Blobovnicza) Open ¶
func (b *Blobovnicza) Open() error
Open opens an internal database at the configured path with the configured permissions.
If the database file does not exist, it will be created automatically.
func (*Blobovnicza) Put ¶
func (b *Blobovnicza) Put(prm PutPrm) (PutRes, error)
Put saves an object in Blobovnicza.
If binary representation of the object is not set, it is calculated via Marshal method.
The size of the object MUST BE less that or equal to the size specified in WithObjectSizeLimit option.
Returns any error encountered that did not allow to completely save the object.
Returns ErrFull if blobovnicza is filled.
Should not be called in read-only configuration.
type DeletePrm ¶
type DeletePrm struct {
// contains filtered or unexported fields
}
DeletePrm groups the parameters of Delete operation.
func (*DeletePrm) SetAddress ¶
SetAddress sets the address of the requested object.
type DeleteRes ¶
type DeleteRes struct {
}
DeleteRes groups the resulting values of Delete operation.
type GetPrm ¶
type GetPrm struct {
// contains filtered or unexported fields
}
GetPrm groups the parameters of Get operation.
func (*GetPrm) SetAddress ¶
SetAddress sets the address of the requested object.
type GetRes ¶
type GetRes struct {
// contains filtered or unexported fields
}
GetRes groups the resulting values of Get operation.
type ID ¶
type ID []byte
ID represents Blobovnicza identifier.
func NewIDFromBytes ¶
NewIDFromBytes constructs an ID from a byte slice.
type IteratePrm ¶
type IteratePrm struct {
// contains filtered or unexported fields
}
IteratePrm groups the parameters of Iterate operation.
func (*IteratePrm) DecodeAddresses ¶
func (x *IteratePrm) DecodeAddresses()
DecodeAddresses sets flag to unmarshal object addresses.
func (*IteratePrm) IgnoreErrors ¶
func (x *IteratePrm) IgnoreErrors()
IgnoreErrors makes all errors to be ignored.
func (*IteratePrm) SetHandler ¶
func (x *IteratePrm) SetHandler(h IterationHandler)
SetHandler sets handler to be called iteratively.
func (*IteratePrm) WithoutData ¶
func (x *IteratePrm) WithoutData()
WithoutData sets flag to not read data of the objects.
type IterateRes ¶
type IterateRes struct {
}
IterateRes groups the resulting values of Iterate operation.
type IterationElement ¶
type IterationElement struct {
// contains filtered or unexported fields
}
IterationElement represents a unit of elements through which Iterate operation passes.
func (IterationElement) Address ¶
func (x IterationElement) Address() oid.Address
Address returns address of the stored object.
func (IterationElement) ObjectData ¶
func (x IterationElement) ObjectData() []byte
ObjectData returns stored object in a binary representation.
type IterationHandler ¶
type IterationHandler func(IterationElement) error
IterationHandler is a generic processor of IterationElement.
type Option ¶
type Option func(*cfg)
Option is an option of Blobovnicza's constructor.
func WithFullSizeLimit ¶
WithFullSizeLimit returns an option to set the maximum sum size of all stored objects.
func WithLogger ¶
WithLogger returns an option to specify Blobovnicza's logger.
func WithObjectSizeLimit ¶
WithObjectSizeLimit returns an option to specify the maximum size of the objects stored in Blobovnicza.
func WithPermissions ¶
WithPermissions returns an option to specify permission bits of Blobovnicza's system path.
func WithReadOnly ¶
WithReadOnly returns an option to open Blobovnicza in read-only mode.
type PutPrm ¶
type PutPrm struct {
// contains filtered or unexported fields
}
PutPrm groups the parameters of Put operation.
func (*PutPrm) SetAddress ¶
SetAddress sets the address of the saving object.
func (*PutPrm) SetMarshaledObject ¶
SetMarshaledObject sets binary representation of the object.
Source Files