services

Documentation

Index

• Constants
• Variables
• type InitError
  • func (e *InitError) Error() string
  • func (e *InitError) Unwrap() error
• type MetadataUnrecognizedError
  • func NewMetadataNotRecognizedError(key string, value interface{}) *MetadataUnrecognizedError
  • func (e *MetadataUnrecognizedError) Error() string
  • func (e *MetadataUnrecognizedError) Unwrap() error
• type PairRequiredError
  • func NewPairRequiredError(keys ...string) *PairRequiredError
  • func (e *PairRequiredError) Error() string
  • func (e *PairRequiredError) Unwrap() error
• type PairUnsupportedError
  • func NewPairUnsupportedError(pair *types.Pair) *PairUnsupportedError
  • func (e *PairUnsupportedError) Error() string
  • func (e *PairUnsupportedError) Unwrap() error
• type ServiceError
  • func (e *ServiceError) Error() string
  • func (e *ServiceError) Unwrap() error
• type StorageError
  • func (e *StorageError) Error() string
  • func (e *StorageError) Unwrap() error

Constants

const (
	// Init related op
	OpNewServicer = "new_servicer"
	OpNewStorager = "new_storager"

	// Service related op
	OpList   = "list"
	OpGet    = "get"
	OpCreate = "create"
	OpDelete = "delete"

	// Storage related op
	OpListPrefix = "list_prefix"
	OpListDir    = "list_dir"
	OpRead       = "read"
	OpWrite      = "write"
	OpStat       = "stat"

	// Extended op
	OpCopy        = "copy"
	OpMove        = "move"
	OpReach       = "reach"
	OpStatistical = "statistical"

	// Segment related op
	OpListPrefixSegments = "list_prefix_segments"
	OpInitIndexSegment   = "init_index_segment"
	OpWriteIndexSegment  = "write_index_segment"
	OpCompleteSegment    = "complete_segment"
	OpAbortSegment       = "abort_segment"
)

All public op are listed here for references.

Variables

var (
	// ErrCapabilityInsufficient means this service doesn't have this capability
	ErrCapabilityInsufficient = errors.New("capability insufficient")
	// ErrRestrictionDissatisfied means this operation doesn't meat service's restriction.
	ErrRestrictionDissatisfied = errors.New("restriction dissatisfied")

	// ErrObjectNotExist means the object to be operated is not exist.
	ErrObjectNotExist = errors.New("object not exist")
	// ErrPermissionDenied means this operation doesn't have enough permission.
	ErrPermissionDenied = errors.New("permission denied")
)

Types

type InitError

type InitError struct {
	Op   string
	Type string
	Err  error

	Pairs []*types.Pair
}

InitError means this service init failed.

Only returned in New

func (*InitError) Error

func (e *InitError) Error() string

func (*InitError) Unwrap

func (e *InitError) Unwrap() error

Unwrap implements xerrors.Wrapper

type MetadataUnrecognizedError

type MetadataUnrecognizedError struct {
	Err error

	Key   string
	Value interface{}
}

MetadataUnrecognizedError means this operation meets unrecognized metadata.

func NewMetadataNotRecognizedError

func NewMetadataNotRecognizedError(key string, value interface{}) *MetadataUnrecognizedError

NewMetadataNotRecognizedError will create a new MetadataUnrecognizedError.

func (*MetadataUnrecognizedError) Error

func (e *MetadataUnrecognizedError) Error() string

func (*MetadataUnrecognizedError) Unwrap

func (e *MetadataUnrecognizedError) Unwrap() error

Unwrap implements xerrors.Wrapper

type PairRequiredError

type PairRequiredError struct {
	Err error

	Keys []string
}

PairRequiredError means this operation has required pair but missing.

func NewPairRequiredError

func NewPairRequiredError(keys ...string) *PairRequiredError

NewPairRequiredError will create a new PairRequiredError.

func (*PairRequiredError) Error

func (e *PairRequiredError) Error() string

func (*PairRequiredError) Unwrap

func (e *PairRequiredError) Unwrap() error

Unwrap implements xerrors.Wrapper

type PairUnsupportedError

type PairUnsupportedError struct {
	Err error

	Pair *types.Pair
}

PairUnsupportedError means this operation has unsupported pair.

func NewPairUnsupportedError

func NewPairUnsupportedError(pair *types.Pair) *PairUnsupportedError

NewPairUnsupportedError will create a new PairUnsupportedError.

func (*PairUnsupportedError) Error

func (e *PairUnsupportedError) Error() string

func (*PairUnsupportedError) Unwrap

func (e *PairUnsupportedError) Unwrap() error

Unwrap implements xerrors.Wrapper

type ServiceError

type ServiceError struct {
	Op  string
	Err error

	storage.Servicer
	Name string
}

ServiceError represent errors related to service.

Only returned in Servicer related operations

func (*ServiceError) Error

func (e *ServiceError) Error() string

func (*ServiceError) Unwrap

func (e *ServiceError) Unwrap() error

Unwrap implements xerrors.Wrapper

type StorageError

type StorageError struct {
	Op  string
	Err error

	storage.Storager
	Path []string
}

StorageError represent errors related to storage.

Only returned in Storager related operations

func (*StorageError) Error

func (e *StorageError) Error() string

func (*StorageError) Unwrap

func (e *StorageError) Unwrap() error

Unwrap implements xerrors.Wrapper