file

Documentation

Index

• type System
  • func NewSystem() *System
  • func (System) Exists(path string) bool
  • func (System) Read(path string) (io.ReadCloser, error)
  • func (System) Walk(workspace string, extensions []string, cb func(string)) error
  • func (System) Write(path string) (io.WriteCloser, error)

Types

type System

type System struct{}

System represents an interface with the filesystem.

func NewSystem

func NewSystem() *System

NewSystem returns a new System.

func (System) Exists

func (System) Exists(path string) bool

Exists checks the existence of the file at path.

func (System) Read

func (System) Read(path string) (io.ReadCloser, error)

Read returns an io.ReadCloser from the file at path.

func (System) Walk

func (System) Walk(workspace string, extensions []string, cb func(string)) error

Walk walks recursively in workspace and calls the callback for all files that match one of the extension and is not hidden (does not start with a dot ".").

The function expects the extensions with a dot: [".md"].

func (System) Write

func (System) Write(path string) (io.WriteCloser, error)

Write returns an io.WriteCloser to the file at path.