objst

Jul 6, 2023

Changes in this version

+ const OperationDelete

+ const OperationGet

+ var SystemOwner = uuid.NewString()

+ type BucketOptions badger.Options

+ func NewDefaultBucketOptions() BucketOptions

Jul 5, 2023

Changes in this version

+ const Delete

+ const Get

+ var ErrEmptyQuery = errors.New("empty query")

+ var ErrInvalidNamePattern = fmt.Errorf("object name must match the following regex pattern: %s", objectNamePattern)

+ var ErrMissingOwner = errors.New("missing owner in the request context")

+ var ErrNameOwnerCtxMissing = errors.New("name is set but missing owner")

+ var ErrUknownContentType = errors.New(...)

+ func DefaultOptions() badger.Options

type Bucket

+ func (b Bucket) Delete(q *Query) error

+ func (b Bucket) Execute(q *Query) ([]*Object, error)

+ func (b Bucket) Get(q *Query) ([]*Object, error)

+ func (b Bucket) GetMeta(id string) (*Metadata, error)

+ func (b Bucket) Read(id string, w io.Writer) error

+ type CtxKey string

+ const CtxKeyOwner

+ const CtxKeyReqID

+ type HTTPHandler struct

+ func NewHTTPHandler(bucket *Bucket, opts HTTPHandlerOptions) *HTTPHandler

+ func (h *HTTPHandler) Get(w http.ResponseWriter, r *http.Request)

+ func (h *HTTPHandler) Read(w http.ResponseWriter, r *http.Request)

+ func (h *HTTPHandler) Remove(w http.ResponseWriter, r *http.Request)

+ func (h *HTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *HTTPHandler) Upload(w http.ResponseWriter, r *http.Request)

+ type HTTPHandlerOptions struct

+ FormKey string

+ Handler http.Handler

+ IsAuthenticated func(http.Handler) http.Handler

+ IsAuthorized func(http.Handler) http.Handler

+ Logger *slog.Logger

+ MaxUploadSize int64

+ func DefaultHTTPHandlerOptions() HTTPHandlerOptions

+ type MetaKey string

+ const MetaKeyContentType

+ const MetaKeyCreatedAt

+ const MetaKeyID

+ const MetaKeyName

+ const MetaKeyOwner

+ func (m MetaKey) String() string

+ type Metadata struct

+ func NewMetadata() *Metadata

+ func (m *Metadata) Compare(md *Metadata, act action) bool

+ func (m *Metadata) Unmarshal(data []byte) error

+ func (m Metadata) Del(k MetaKey)

+ func (m Metadata) Encode() string

+ func (m Metadata) Get(k MetaKey) string

+ func (m Metadata) Has(k MetaKey) bool

+ func (m Metadata) Is(k MetaKey, v string) bool

+ func (m Metadata) Marshal() ([]byte, error)

+ func (m Metadata) Merge(mp map[MetaKey]string)

+ func (m Metadata) Set(k MetaKey, v string)

+ func (m Metadata) UserDefinedPairs() map[MetaKey]string

type Object

+ func (o *Object) GetMetaKey(k MetaKey) string

+ func (o *Object) SetMetaKey(k MetaKey, v string)

type Query

+ func (q *Query) Action(act action) *Query

+ func (q *Query) ID(id string) *Query

+ func (q *Query) Name(name string) *Query

+ func (q *Query) Operation(op operation) *Query

+ func (q *Query) Owner(owner string) *Query

+ func (q *Query) Param(k MetaKey, v string) *Query

Jul 1, 2023

Changes in this version

+ var ErrMustIncludeOwnerAndName = errors.New("object is immutable. Create a new object")

Jun 30, 2023

Changes in this version

+ const And

+ const ContentTypeMetaKey

+ const Or

+ var ErrContentTypeNotExist = errors.New("missing content type metadata")

+ var ErrEmptyPayload = errors.New("object doesn't contain any payload")

+ var ErrInvalidQuery = errors.New("query is invalid. Missing owner")

+ var ErrObjectIsImmutable = errors.New("object is immutable. Create a new object")

+ var ErrUnauthorized = errors.New("owner is not authorized to access the object")

+ type Bucket struct

+ func NewBucket(opts *badger.Options) (*Bucket, error)

+ func (b Bucket) BatchCreate(objs []*Object) error

+ func (b Bucket) Create(obj *Object) error

+ func (b Bucket) DeleteByID(id string) error

+ func (b Bucket) DeleteByName(name, owner string) error

+ func (b Bucket) FilterByMeta(objs []*Object, metas url.Values, act action) []*Object

+ func (b Bucket) GetByID(id string) (*Object, error)

+ func (b Bucket) GetByMeta(meta url.Values, act action) ([]*Object, error)

+ func (b Bucket) GetByName(name, owner string) (*Object, error)

+ func (b Bucket) GetByOwner(owner string) ([]*Object, error)

+ func (b Bucket) IsAuthorized(owner string, id string) (*Object, error)

+ func (b Bucket) RunQuery(q *Query) ([]*Object, error)

+ func (b Bucket) Shutdown() error

+ type Object struct

+ func NewObject(name, owner string) *Object

+ func (o *Object) BinaryMarshaler() ([]byte, error)

+ func (o *Object) BinaryUnmarshaler(data []byte) error

+ func (o *Object) FromModel(m *models.Object)

+ func (o *Object) GetMeta(k string) (string, bool)

+ func (o *Object) HasMetaKey(k string) bool

+ func (o *Object) Marshal() ([]byte, error)

+ func (o *Object) Read(b []byte) (int, error)

+ func (o *Object) ReadFrom(r io.Reader) (int64, error)

+ func (o *Object) Reset()

+ func (o *Object) SetMeta(k, v string)

+ func (o *Object) ToModel() *models.Object

+ func (o *Object) Unmarshal(data []byte) error

+ func (o *Object) Write(p []byte) (int, error)

+ func (o *Object) WriteTo(w io.Writer) (int64, error)

+ func (o Object) ID() string

+ func (o Object) Name() string

+ func (o Object) Owner() string

+ func (o Object) Payload() []byte

+ type Query struct

+ func NewQuery(owner string) *Query

+ func (q *Query) WithAction(act action) *Query

+ func (q *Query) WithMeta(meta url.Values, act action) *Query

+ func (q *Query) WithOwner(owner string) *Query