storage

Documentation

Index

• Constants
• type BlobStorage
• type Document
• type DocumentStorer
• type ExportOption
• type MetadataStorer
• type UserStorer

Constants

const (
	MetadataFileExt = ".metadata"
	PageFileExt     = ".pagedata"
	ContentFileExt  = ".content"
	RmFileExt       = ".rm"

	//ZipFileExt zip file extension
	ZipFileExt = ".zip"
	//EpubFileExt epub
	EpubFileExt = ".epub"
	//PdfFileExt pdf
	PdfFileExt = ".pdf"
	//RmDoc
	RmDocFileExt = ".rmdoc"
)

Types

type BlobStorage

type BlobStorage interface {
	GetBlobURL(uid, docid string, write bool) (string, time.Time, error)

	StoreBlob(uid, blobID string, s io.Reader, matchGeneration int64) (int64, error)
	LoadBlob(uid, blobID string) (reader io.ReadCloser, gen int64, size int64, crc32c string, err error)
	CreateBlobDocument(uid, name, parent string, stream io.Reader) (doc *Document, err error)
}

BlobStorage stuff for sync15

type Document

type Document struct {
	ID      string
	Type    common.EntryType
	Parent  string
	Name    string
	Version int
}

Document represents a document in storage

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(uid, docid string) (string, time.Time, error)
	CreateDocument(uid, name, parent string, stream io.Reader) (doc *Document, err error)
}

DocumentStorer stores documents

type ExportOption

type ExportOption int

ExportOption type of export

const (
	ExportWithAnnotations ExportOption = iota
	ExportOnlyAnnotations
	ExportPayload
)

type MetadataStorer

type MetadataStorer interface {
	UpdateMetadata(uid string, r *messages.RawMetadata) error
	GetAllMetadata(uid string) ([]*messages.RawMetadata, error)
	GetMetadata(uid, docid string) (*messages.RawMetadata, 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
	RemoveUser(uid string) error
}

UserStorer holds informations about users