directories

Documentation

Overview

Package directories interacts with the filepaths that hold files and assets.

Index

• Variables
• func ArchiveExt(name string) bool
• func PlaceHolders(dir *Dir) error
• func Size(root string) (count int64, bytes uint64, err error)
• type Dir
  • func Files(name string) Dir
  • func Init(create bool) Dir

Variables

var ErrNoDir = errors.New("dir structure cannot be nil")

Functions

func ArchiveExt

func ArchiveExt(name string) bool

ArchiveExt checks that the named file uses a known archive extension.

func PlaceHolders

func PlaceHolders(dir *Dir) error

PlaceHolders generates a collection placeholder files in the UUID subdirectories.

func Size

func Size(root string) (count int64, bytes uint64, err error)

Size returns the number of counted files and their summed size as bytes.

Types

type Dir

type Dir struct {
	Img000 string // Img000 hold screen captures and previews.
	Img400 string // Img400 hold 400x400 squared thumbnails.
	Backup string // Backup archives or previously removed files.
	Emu    string // Emu are the DOSee emulation files.
	Base   string // Base or root directory path, the parent of these other subdirectories.
	UUID   string // UUID file downloads.
}

Dir is the collection of directories pointing to specific files.

func Files

func Files(name string) Dir

Files initialises the full path filenames for a UUID.

func Init

func Init(create bool) Dir

Init initialises the subdirectories and UUID structure.