vfsutil

Documentation

Overview

Package vfsutil contains small utility functions for working with virtual filesystems. See the docs for github.com/rainycape/vfs for more information.

Index

• func Bake(w io.Writer, dir string, extensions []string) error
• type VFS
  • func MemFromDir(dir string) VFS
  • func MustOpenBaked(s string) VFS
  • func OpenBaked(s string) (VFS, error)

Functions

func Bake

func Bake(w io.Writer, dir string, extensions []string) error

Bake writes the data for a VFS generated from dir to the given io.Writer. The extensions argument can be used to limit the files included in the VFS by their extension. If empty, all files are included.

Types

type VFS

type VFS interface {
	vfs.VFS
}

VFS is just an alias for github.com/rainycape/vfs.VFS, to avoid importing the latter.

func MemFromDir

func MemFromDir(dir string) VFS

func MustOpenBaked

func MustOpenBaked(s string) VFS

MustOpenBaked is a shorthand for OpenBaked() which panics.

func OpenBaked

func OpenBaked(s string) (VFS, error)

OpenBaked opens a VFS baked into a string using gondola bake