frostfs

Documentation

Index

• func IsErrObjectAccessDenied(err error) (string, bool)
• func IsTimeoutError(err error) bool
• func UnwrapErr(err error) error
• type FrostFS
  • func NewFrostFS(p *pool.Pool) *FrostFS
  • func (x *FrostFS) Container(ctx context.Context, containerPrm handler.PrmContainer) (*container.Container, error)
  • func (x *FrostFS) CreateObject(ctx context.Context, prm handler.PrmObjectCreate) (oid.ID, error)
  • func (x *FrostFS) GetEpochDurations(ctx context.Context) (*utils.EpochDurations, error)
  • func (x *FrostFS) GetObject(ctx context.Context, prm handler.PrmObjectGet) (*handler.Object, error)
  • func (x *FrostFS) HeadObject(ctx context.Context, prm handler.PrmObjectHead) (*object.Object, error)
  • func (x *FrostFS) InitFrostFSObjectPayloadReader(ctx context.Context, p GetFrostFSParams) (io.ReadCloser, error)
  • func (x *FrostFS) InitMultiObjectReader(ctx context.Context, p handler.PrmInitMultiObjectReader) (io.Reader, error)
  • func (x *FrostFS) RangeObject(ctx context.Context, prm handler.PrmObjectRange) (io.ReadCloser, error)
  • func (x *FrostFS) SearchObjects(ctx context.Context, prm handler.PrmObjectSearch) (handler.ResObjectSearch, error)
• type GetFrostFSParams
• type GetNodeByPathResponseInfoWrapper
  • func (n GetNodeByPathResponseInfoWrapper) GetMeta() []tree.Meta
  • func (n GetNodeByPathResponseInfoWrapper) GetNodeID() []uint64
  • func (n GetNodeByPathResponseInfoWrapper) GetParentID() []uint64
  • func (n GetNodeByPathResponseInfoWrapper) GetTimestamp() []uint64
• type GetSubTreeResponseBodyWrapper
  • func (n GetSubTreeResponseBodyWrapper) GetMeta() []tree.Meta
  • func (n GetSubTreeResponseBodyWrapper) GetNodeID() []uint64
  • func (n GetSubTreeResponseBodyWrapper) GetParentID() []uint64
  • func (n GetSubTreeResponseBodyWrapper) GetTimestamp() []uint64
• type MultiObjectReader
  • func NewMultiObjectReader(ctx context.Context, cfg MultiObjectReaderConfig) (*MultiObjectReader, error)
  • func (x *MultiObjectReader) Read(p []byte) (n int, err error)
• type MultiObjectReaderConfig
• type PartInfo
• type PartObj
• type PoolWrapper
  • func NewPoolWrapper(p *treepool.Pool) *PoolWrapper
  • func (w *PoolWrapper) GetNodes(ctx context.Context, prm *tree.GetNodesParams) ([]tree.NodeResponse, error)
  • func (w *PoolWrapper) GetSubTree(ctx context.Context, bktInfo *data.BucketInfo, treeID string, rootID []uint64, ...) ([]tree.NodeResponse, error)
• type ResolverFrostFS
  • func NewResolverFrostFS(p *pool.Pool) *ResolverFrostFS
  • func (x *ResolverFrostFS) SystemDNS(ctx context.Context) (string, error)

Functions

func IsErrObjectAccessDenied

func IsErrObjectAccessDenied(err error) (string, bool)

func IsTimeoutError

func IsTimeoutError(err error) bool

func UnwrapErr

func UnwrapErr(err error) error

Types

type FrostFS

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

FrostFS represents virtual connection to the FrostFS network. It is used to provide an interface to dependent packages which work with FrostFS.

func NewFrostFS

func NewFrostFS(p *pool.Pool) *FrostFS

NewFrostFS creates new FrostFS using provided pool.Pool.

func (*FrostFS) Container

func (x *FrostFS) Container(ctx context.Context, containerPrm handler.PrmContainer) (*container.Container, error)

Container implements frostfs.FrostFS interface method.

func (*FrostFS) CreateObject

func (x *FrostFS) CreateObject(ctx context.Context, prm handler.PrmObjectCreate) (oid.ID, error)

CreateObject implements frostfs.FrostFS interface method.

func (*FrostFS) GetEpochDurations

func (x *FrostFS) GetEpochDurations(ctx context.Context) (*utils.EpochDurations, error)

GetEpochDurations implements frostfs.FrostFS interface method.

func (*FrostFS) GetObject

func (x *FrostFS) GetObject(ctx context.Context, prm handler.PrmObjectGet) (*handler.Object, error)

GetObject implements frostfs.FrostFS interface method.

func (*FrostFS) HeadObject

func (x *FrostFS) HeadObject(ctx context.Context, prm handler.PrmObjectHead) (*object.Object, error)

HeadObject implements frostfs.FrostFS interface method.

func (*FrostFS) InitFrostFSObjectPayloadReader

func (x *FrostFS) InitFrostFSObjectPayloadReader(ctx context.Context, p GetFrostFSParams) (io.ReadCloser, error)

InitFrostFSObjectPayloadReader initializes payload reader of the FrostFS object. Zero range corresponds to full payload (panics if only offset is set).

func (*FrostFS) InitMultiObjectReader

func (x *FrostFS) InitMultiObjectReader(ctx context.Context, p handler.PrmInitMultiObjectReader) (io.Reader, error)

func (*FrostFS) RangeObject

func (x *FrostFS) RangeObject(ctx context.Context, prm handler.PrmObjectRange) (io.ReadCloser, error)

RangeObject implements frostfs.FrostFS interface method.

func (*FrostFS) SearchObjects

func (x *FrostFS) SearchObjects(ctx context.Context, prm handler.PrmObjectSearch) (handler.ResObjectSearch, error)

SearchObjects implements frostfs.FrostFS interface method.

type GetFrostFSParams

type GetFrostFSParams struct {
	// payload range
	Off, Ln uint64
	Addr    oid.Address
}

type GetNodeByPathResponseInfoWrapper

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

func (GetNodeByPathResponseInfoWrapper) GetMeta

func (n GetNodeByPathResponseInfoWrapper) GetMeta() []tree.Meta

func (GetNodeByPathResponseInfoWrapper) GetNodeID

func (n GetNodeByPathResponseInfoWrapper) GetNodeID() []uint64

func (GetNodeByPathResponseInfoWrapper) GetParentID

func (n GetNodeByPathResponseInfoWrapper) GetParentID() []uint64

func (GetNodeByPathResponseInfoWrapper) GetTimestamp

func (n GetNodeByPathResponseInfoWrapper) GetTimestamp() []uint64

type GetSubTreeResponseBodyWrapper

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

func (GetSubTreeResponseBodyWrapper) GetMeta

func (n GetSubTreeResponseBodyWrapper) GetMeta() []tree.Meta

func (GetSubTreeResponseBodyWrapper) GetNodeID

func (n GetSubTreeResponseBodyWrapper) GetNodeID() []uint64

func (GetSubTreeResponseBodyWrapper) GetParentID

func (n GetSubTreeResponseBodyWrapper) GetParentID() []uint64

func (GetSubTreeResponseBodyWrapper) GetTimestamp

func (n GetSubTreeResponseBodyWrapper) GetTimestamp() []uint64

type MultiObjectReader

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

MultiObjectReader implements io.Reader of payloads of the object list stored in the FrostFS network.

func NewMultiObjectReader

func NewMultiObjectReader(ctx context.Context, cfg MultiObjectReaderConfig) (*MultiObjectReader, error)

func (*MultiObjectReader) Read

func (x *MultiObjectReader) Read(p []byte) (n int, err error)

type MultiObjectReaderConfig

type MultiObjectReaderConfig struct {
	Initiator readerInitiator

	// the offset of complete object and total size to read
	Off, Ln uint64

	Addr  oid.Address
	Parts []PartObj
}

type PartInfo

type PartInfo struct {
	Key      string    `json:"key"`
	UploadID string    `json:"uploadId"`
	Number   int       `json:"number"`
	OID      oid.ID    `json:"oid"`
	Size     uint64    `json:"size"`
	ETag     string    `json:"etag"`
	MD5      string    `json:"md5"`
	Created  time.Time `json:"created"`
}

PartInfo is upload information about part.

type PartObj

type PartObj struct {
	OID  oid.ID
	Size uint64
}

type PoolWrapper

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

func NewPoolWrapper

func NewPoolWrapper(p *treepool.Pool) *PoolWrapper

func (*PoolWrapper) GetNodes

func (w *PoolWrapper) GetNodes(ctx context.Context, prm *tree.GetNodesParams) ([]tree.NodeResponse, error)

func (*PoolWrapper) GetSubTree

func (w *PoolWrapper) GetSubTree(ctx context.Context, bktInfo *data.BucketInfo, treeID string, rootID []uint64, depth uint32, sort bool) ([]tree.NodeResponse, error)

type ResolverFrostFS

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

ResolverFrostFS represents virtual connection to the FrostFS network. It implements resolver.FrostFS.

func NewResolverFrostFS

func NewResolverFrostFS(p *pool.Pool) *ResolverFrostFS

NewResolverFrostFS creates new ResolverFrostFS using provided pool.Pool.

func (*ResolverFrostFS) SystemDNS

func (x *ResolverFrostFS) SystemDNS(ctx context.Context) (string, error)

SystemDNS implements resolver.FrostFS interface method.