dir

Documentation

Index

• type Child
• type Directory
  • func CurrentDirectory() (d *Directory, err error)
  • func NewDirectory(name string) *Directory
  • func (d *Directory) AddDirectory(dir *Directory) *Directory
  • func (d *Directory) AddDirectoryName(s string) *Directory
  • func (d *Directory) AddFile(f *File)
  • func (d *Directory) AllChildren() (c []Child)
  • func (d Directory) Parents() (s []*Directory)
  • func (d Directory) Path() string
  • func (d Directory) String() string
  • func (d Directory) Write() error
  • func (d Directory) WriteAll() error
• type File
  • func NewFile(name string) *File
  • func NewFileContent(name, content string) (f *File)
  • func (f File) FullName() string
  • func (f File) Parents() (s []*Directory)
  • func (f File) Path() string
  • func (f File) Read() error
  • func (f File) String() string
  • func (f File) Write() error
  • func (f File) WritePerm(perm os.FileMode) error

Types

type Child

type Child interface {
	Parents() []*Directory
	Path() string
}

Child is an interface for the child of a directory

type Directory

type Directory struct {
	Name     string
	Parent   *Directory
	Children []Child
}

Directory ...

func CurrentDirectory

func CurrentDirectory() (d *Directory, err error)

CurrentDirectory returns a pointer to the current directory

func NewDirectory

func NewDirectory(name string) *Directory

NewDirectory returns a pointer to a directory object with a specified name

func (*Directory) AddDirectory

func (d *Directory) AddDirectory(dir *Directory) *Directory

AddDirectory adds a child directory to a directory

func (*Directory) AddDirectoryName

func (d *Directory) AddDirectoryName(s string) *Directory

AddDirectoryName adds a child directory with a specified name to a directory

func (*Directory) AddFile

func (d *Directory) AddFile(f *File)

AddFile adds a file to a directory

func (*Directory) AllChildren

func (d *Directory) AllChildren() (c []Child)

AllChildren recurses the a directories children and returns a slice of children

func (Directory) Parents

func (d Directory) Parents() (s []*Directory)

Parents impements Child and returns all the parents of a directory

func (Directory) Path

func (d Directory) Path() string

Path impements Child and returns the full path to a directory

func (Directory) String

func (d Directory) String() string

String implements Stringer and returns the name of a directory

func (Directory) Write

func (d Directory) Write() error

Write writes a directory to disk

func (Directory) WriteAll

func (d Directory) WriteAll() error

WriteAll recurses a directory and all it's children and writes it to disk

type File

type File struct {
	Name    string
	Ext     string
	Content string
	Parent  *Directory
}

File ...

func NewFile

func NewFile(name string) *File

NewFile returns a pointer to a File with a specified name

func NewFileContent

func NewFileContent(name, content string) (f *File)

NewFileContent returns a pointer to a File with a specified name and contents

func (File) FullName

func (f File) FullName() string

String returns a formatted string of the file's name and extension

func (File) Parents

func (f File) Parents() (s []*Directory)

Parents impements Child and returns all the parents of a file

func (File) Path

func (f File) Path() string

Path impements Child and returns the full path to a file

func (File) Read

func (f File) Read() error

Read populates the content of the file from the path

func (File) String

func (f File) String() string

String implements Stringer and return the full name of the file

func (File) Write

func (f File) Write() error

Write writes contents of the file to disk

func (File) WritePerm

func (f File) WritePerm(perm os.FileMode) error

WritePerm writes contents of the file to disk with specified permissions