models

Documentation

Index

• Constants
• Variables
• func NewRememberToken() (string, error)
• type File
  • func (f *File) Fake(faker *gofakeit.Faker) (any, error)
  • func (f *File) Validate() error
• type Filter
• type Folder
  • func NewFolder(spaceID string, name string) *Folder
  • func (f *Folder) Fake(faker *gofakeit.Faker) (any, error)
  • func (f *Folder) PostponeExpiration() time.Time
  • func (f *Folder) Slug() string
  • func (f *Folder) TotalDownloads() (n int64)
  • func (f *Folder) TotalSize() (n int64)
  • func (f *Folder) Validate() error
• type Pagination
  • func NewPagination(offset int, limit int, sort string, filters ...Filter) *Pagination
  • func (p *Pagination) CurrentPage() int
  • func (p *Pagination) EndOfPage() int
  • func (p *Pagination) Filter(name string) (Filter, bool)
  • func (p *Pagination) FilterValue(name string) string
  • func (p *Pagination) Limit() int
  • func (p *Pagination) NumberOfPages() int
  • func (p *Pagination) Offset() int
  • func (p *Pagination) PageOffset(page int) int
  • func (p *Pagination) PaginationString() string
  • func (p *Pagination) SetTotal(total int)
  • func (p *Pagination) Sort() string
  • func (p *Pagination) StartOfPage() int
  • func (p *Pagination) ToPairs() []string
  • func (p *Pagination) Total() int
  • func (p *Pagination) VisiblePages() []int
• type Permissions
  • func (p *Permissions) IsAdmin(user *User) bool
  • func (p *Permissions) IsSpaceAdmin(user *User, space *Space) bool
• type Space
  • func (s *Space) Fake(faker *gofakeit.Faker) (any, error)
  • func (s *Space) Validate() error
• type User
  • func (u *User) Fake(faker *gofakeit.Faker) (any, error)
  • func (u *User) Validate() error

Constants

const PostponePeriod = 30 * 24 * time.Hour

Variables

var ErrNotFound = errors.New("not found")

Functions

func NewRememberToken

func NewRememberToken() (string, error)

Types

type File

type File struct {
	ID          string    `json:"id,omitempty"`
	FolderID    string    `json:"folder_id,omitempty"`
	MD5         string    `json:"md5,omitempty"`
	Name        string    `json:"name,omitempty"`
	Size        int64     `json:"size,omitempty"`
	ContentType string    `json:"content_type,omitempty"`
	Downloads   int64     `json:"downloads,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	// relations (can be empty)
	Folder *Folder `json:"folder,omitempty"`
}

func (*File) Fake

func (f *File) Fake(faker *gofakeit.Faker) (any, error)

func (*File) Validate

func (f *File) Validate() error

type Filter

type Filter struct {
	Name, Value string
}

type Folder

type Folder struct {
	ID        string    `json:"id,omitempty"`
	SpaceID   string    `json:"space_id,omitempty"`
	Name      string    `json:"name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	ExpiresAt time.Time `json:"expires_at,omitempty"`
	// relations (can be empty)
	Space *Space  `json:"space,omitempty"`
	Files []*File `json:"files,omitempty"`
}

func NewFolder

func NewFolder(spaceID string, name string) *Folder

func (*Folder) Fake

func (f *Folder) Fake(faker *gofakeit.Faker) (any, error)

func (*Folder) PostponeExpiration

func (f *Folder) PostponeExpiration() time.Time

func (*Folder) Slug

func (f *Folder) Slug() string

func (*Folder) TotalDownloads

func (f *Folder) TotalDownloads() (n int64)

func (*Folder) TotalSize

func (f *Folder) TotalSize() (n int64)

func (*Folder) Validate

func (f *Folder) Validate() error

type Pagination

type Pagination struct {
	// contains filtered or unexported fields
}

func NewPagination

func NewPagination(offset int, limit int, sort string, filters ...Filter) *Pagination

func (*Pagination) CurrentPage

func (p *Pagination) CurrentPage() int

func (*Pagination) EndOfPage

func (p *Pagination) EndOfPage() int

func (*Pagination) Filter

func (p *Pagination) Filter(name string) (Filter, bool)

func (*Pagination) FilterValue

func (p *Pagination) FilterValue(name string) string

func (*Pagination) Limit

func (p *Pagination) Limit() int

func (*Pagination) NumberOfPages

func (p *Pagination) NumberOfPages() int

func (*Pagination) Offset

func (p *Pagination) Offset() int

func (*Pagination) PageOffset

func (p *Pagination) PageOffset(page int) int

func (*Pagination) PaginationString

func (p *Pagination) PaginationString() string

func (*Pagination) SetTotal

func (p *Pagination) SetTotal(total int)

func (*Pagination) Sort

func (p *Pagination) Sort() string

func (*Pagination) StartOfPage

func (p *Pagination) StartOfPage() int

func (*Pagination) ToPairs

func (p *Pagination) ToPairs() []string

func (*Pagination) Total

func (p *Pagination) Total() int

func (*Pagination) VisiblePages

func (p *Pagination) VisiblePages() []int

type Permissions

type Permissions struct {
	Admins []string
}

func (*Permissions) IsAdmin

func (p *Permissions) IsAdmin(user *User) bool

func (*Permissions) IsSpaceAdmin

func (p *Permissions) IsSpaceAdmin(user *User, space *Space) bool

type Space

type Space struct {
	ID        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	Admins    []string  `json:"admins,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// relations (can be empty)
	Folders []*Folder `json:"folders,omitempty"`
}

func (*Space) Fake

func (s *Space) Fake(faker *gofakeit.Faker) (any, error)

func (*Space) Validate

func (s *Space) Validate() error

type User

type User struct {
	ID            string    `json:"id,omitempty"`
	Username      string    `json:"username,omitempty"`
	Name          string    `json:"name,omitempty"`
	Email         string    `json:"email,omitempty"`
	RememberToken string    `json:"remember_token,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
}

func (*User) Fake

func (u *User) Fake(faker *gofakeit.Faker) (any, error)

func (*User) Validate

func (u *User) Validate() error