types

Documentation

Index

• Variables
• func NewErrPairRequired(pair string) error
• type Object
• type ObjectFunc
• type ObjectType
• type Pair

Variables

var (
	// user handleable error
	ErrConfigIncorrect  = errors.New("config incorrect")
	ErrPermissionDenied = errors.New("permission denied")

	// caller handleable error
	ErrPairRequired             = errors.New("pair required")
	ErrObjectNotExist           = errors.New("object not exist")
	ErrStorageClassNotSupported = errors.New("storage class not supported")
	ErrDirNotEmpty              = errors.New("dir not empty")

	// unhandleable error
	ErrUnhandledError = errors.New("unhandled error")
)

All possible error could be return by services.

Functions

func NewErrPairRequired

func NewErrPairRequired(pair string) error

NewErrPairRequired will create a new pair required error.

Types

type Object

type Object struct {
	// ID is the unique key in service.
	ID string
	// name is the relative path towards service's WorkDir.
	Name string
	// type should be one of "file", "stream", "dir" or "invalid".
	Type ObjectType

	// Size is the size of this ObjectMeta.
	// If the ObjectMeta do not have a Size, it will be 0.
	Size int64
	// UpdatedAt is the update time of this ObjectMeta.
	// If the ObjectMeta do not have a UpdatedAt, it will be time.Time{wall:0x0, ext:0, loc:(*time.Location)(nil)}
	UpdatedAt time.Time

	// metadata is the metadata of the object.
	//
	// The difference between `struct value` and `metadata` is:
	//
	// - All value in `struct` are required, caller can use them safely.
	// - All value in `metadata` are optional, caller need to check them before using.
	//
	// Two requirement must be satisfied in order to add struct value, or they need to be
	// a Metadata.
	//
	// - All storage services can provide this value in same way.
	// - User need to access this value.
	metadata.ObjectMeta
}

Object may be a *File, *Dir or a *Stream.

type ObjectFunc

type ObjectFunc func(object *Object)

ObjectFunc will handle an ObjectMeta.

type ObjectType

type ObjectType string

ObjectType is the type for object, under layer type is string.

const (
	ObjectTypeFile    ObjectType = "file"
	ObjectTypeStream  ObjectType = "stream"
	ObjectTypeDir     ObjectType = "dir"
	ObjectTypeInvalid ObjectType = "invalid"
)

All available type for object.

type Pair

type Pair struct {
	Key   string
	Value interface{}
}

Pair will store option for storage service.