storage

Documentation

Index

• type DocumentStorer
• type ExportOption
• type MetadataStorer
• type UserStorer

Types

type DocumentStorer

type DocumentStorer interface {
	StoreDocument(uid, docid string, s io.ReadCloser) error
	RemoveDocument(uid, docid string) error
	GetDocument(uid, docid string) (io.ReadCloser, error)
	ExportDocument(uid, docid, outputType string, exportOption ExportOption) (io.ReadCloser, error)

	// GetStorageURL creates a short lived url
	GetStorageURL(uid, docid string) (string, time.Time, error)

	RegisterRoutes(*gin.Engine)
}

DocumentStorer stores documents

type ExportOption

type ExportOption int

const (
	ExportWithAnnotations ExportOption = iota
	ExportOnlyAnnotations
)

type MetadataStorer

type MetadataStorer interface {
	UpdateMetadata(uid string, r *messages.RawDocument) error
	GetAllMetadata(uid string) ([]*messages.RawDocument, error)
	GetMetadata(uid, docid string) (*messages.RawDocument, error)
}

MetadataStorer manages document metadata

type UserStorer

type UserStorer interface {
	GetUsers() ([]*model.User, error)
	GetUser(string) (*model.User, error)
	RegisterUser(u *model.User) error
	UpdateUser(u *model.User) error
}

UserStorer holds informations about users