fs

Documentation

Overview

Package fs provides functions for filesystem operations.

Index

• Variables
• func MkdirAll(path string, dirs ...string) error
• func Rmdir(fs afero.Fs, path string) error
• func StreamFiles(path string, files chan<- string, filters ...func(file string) bool) error

Variables

var (
	// MarkdownOnly is a filter that only lets pass Markdown files.
	MarkdownOnly = func(file string) bool {
		return filepath.Ext(file) == ".md"
	}

	// NoUnderscores is a predefined filter that doesn't let pass
	// files starting with an underscore.
	NoUnderscores = func(file string) bool {
		filename := filepath.Base(file)
		return !strings.HasPrefix(filename, "_")
	}

	// ErrStreaming is returned from StreamFiles.
	ErrStreaming error = nil
)

Functions

func MkdirAll

func MkdirAll(path string, dirs ...string) error

MkdirAll creates one or more directories inside the given path.

func Rmdir

func Rmdir(fs afero.Fs, path string) error

Rmdir removes an entire directory along with its contents. If the directory does not exist, nothing happens.

func StreamFiles

func StreamFiles(path string, files chan<- string, filters ...func(file string) bool) error

StreamFiles sends all relative file paths inside a given path that match the given filters through the files channel.