electricdusk
/
rushlink
3
3
Fork 3
Code Issues 21 Pull Requests 2 Releases Activity

db: Add missing docs to public symbols

This commit is contained in:
Daan Sprenkels 2019-12-10 12:08:27 +01:00
parent 62e82d831e
commit 76cf92e22d
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
internal/db/paste.go
View File

@ -14,9 +14,13 @@ import (
bolt "go.etcd.io/bbolt" bolt "go.etcd.io/bbolt"
) )
// PasteType describes the type of Paste (i.e. file, redirect, [...]).
type PasteType int type PasteType int
// PasteState describes the state of a Paste (i.e. present, deleted, [...]).
type PasteState int type PasteState int
// Paste describes the main Paste model in the database.
type Paste struct { type Paste struct {
Type PasteType Type PasteType
State PasteState State PasteState
@ -35,6 +39,8 @@ var ReservedPasteKeys = []string{"xd42", "example"}
// allowed at the bottom of this block, for the same reason. // allowed at the bottom of this block, for the same reason.
const ( const (
PasteTypeUndef PasteType = iota PasteTypeUndef PasteType = iota
// PasteTypePaste is as of yet unused. It is still unclear if this type
// will ever get a proper meaning.
PasteTypePaste PasteTypePaste
PasteTypeRedirect PasteTypeRedirect
PasteTypeFileUpload PasteTypeFileUpload
@ -94,6 +100,7 @@ func GetPaste(tx *bolt.Tx, key string) (*Paste, error) {
return p, err return p, err
} }
// Save saves this Paste to the database.
func (p *Paste) Save(tx *bolt.Tx) error { func (p *Paste) Save(tx *bolt.Tx) error {
bucket := tx.Bucket([]byte(BucketPastes)) bucket := tx.Bucket([]byte(BucketPastes))
if bucket == nil { if bucket == nil {
@ -110,6 +117,7 @@ func (p *Paste) Save(tx *bolt.Tx) error {
return nil return nil
} }
// Delete deletes this Paste from the database.
func (p *Paste) Delete(tx *bolt.Tx, fs *FileStore) error { func (p *Paste) Delete(tx *bolt.Tx, fs *FileStore) error {
// Remove the (maybe) attached file // Remove the (maybe) attached file
if p.Type == PasteTypeFileUpload { if p.Type == PasteTypeFileUpload {
@ -226,6 +234,7 @@ func generatePasteKeyInner(epoch int) (string, error) {
return string(urlKey), nil return string(urlKey), nil
} }
// GenerateDeleteToken generates a new (random) delete token.
func GenerateDeleteToken() (string, error) { func GenerateDeleteToken() (string, error) {
var deleteToken [16]byte var deleteToken [16]byte
_, err := rand.Read(deleteToken[:]) _, err := rand.Read(deleteToken[:])