afero

README

afero-lite

A lightweight FileSystem Abstraction System for Go

Modifications

This is afero, reorganized to avoid bloated binaries when a subset of features is used. The following modifications are made:

• tests removed
  • allfiles ending _test.go, as well as gcs_mocks.go
  • count on afero to do the testing
• full package created
  • all of afero moved here except that related to MemMapFs and HttpFs
• mem package now contains NewMemMapFs
• httpfs package created, with NewHttpFs moved here

Thus, the root package only defines the interfaces and allows using the OsFs via NewOsFs. This should keep the amount of imported code to a bare minimum if all you need is to abstract os usage. Use httpfs, knowing that net/http will be imported and increase binary size unless you need it. Use full for all other afero utilities.

Usage

The top-level package is simply named afero:

package main

import "github.com/tbhartman/afero-lite"

func main() {
	var myfs afero.Fs
	myfs = afero.NewOsFs()
	myfs.Stat("myfile")
}

If you need other functionality, import from full, and use as afero:

package main

import (
	"github.com/tbhartman/afero-lite/full"
)

func main() {
	var myfs afero.Fs
	myfs = afero.NewOsFs()
	myfs = afero.NewBasePath(myfs, "basepath")
	myfs.Stat("myfile")
}

If you need a MemMapFs, import from mem:

package main

import (
	"github.com/tbhartman/afero-lite/mem"
)

func main() {
	_ = mem.NewMemMapFs()
}

If you need a HttpFs, import from httpfs:

package main

import (
	"github.com/tbhartman/afero-lite/httpfs"
)

func main() {
	_ = httpfs.NewHttpFs()
}

Versioning

Versioning will follow major and minor releases of afero, but the patch version will update independently as patches to this repo are required!

Update instructions

This is all manual right now :(

• remove _test.go and mock.go files
• create httpfs and full directories
• move httpfs.go to httpfs
• move memmap.go to mem
• move all other root go files to full
• move some files to definition:
  • afero.go
  • const_bsds.go
  • const_win_unix.go
  • lstater.go
  • os.go
  • symlink.go
  • unionFile.go
  • util.go
• remove Afero in definition/afero.go, put rest in full/afero.go
• keep only FilePathSeparator in definition/util.go, put rest in full/util.go
• remove copy* functions from definition/unionFile.go, put in full/unionFile.go
• create afero.go at root:
  • package is afero
  • add import of definition as afero
  • add aliases from definition:
    • go doc -short ./definition | sed 's/^ *\(\w\+\) \(\w\+\).*/\1 \2 = afero.\2/' | sed 's/^func/var/' >> afero.go
  • format via go fmt afero.go
• copy afero.go to full/definition.go
• fix build errors
  • go doc currently misses some Err* defs
  • httpfs.go will need to import and use afero
  • memmap.go will need to import and use afero

Documentation

Index

• Constants
• Variables
• type DirsMerger
• type File
• type Fs
• type LinkReader
• type Linker
• type Lstater
• type OsFs
• type Symlinker
• type UnionFile

Constants

const BADFD = afero.BADFD

const FilePathSeparator = afero.FilePathSeparator

Variables

var ErrDestinationExists = afero.ErrDestinationExists

var ErrFileClosed = afero.ErrFileClosed

var ErrFileExists = afero.ErrFileExists

var ErrFileNotFound = afero.ErrFileNotFound

var ErrNoReadlink = afero.ErrNoReadlink

var ErrNoSymlink = afero.ErrNoSymlink

var ErrOutOfRange = afero.ErrOutOfRange

var ErrTooLarge = afero.ErrTooLarge

var NewOsFs = afero.NewOsFs

Types

type DirsMerger

type DirsMerger = afero.DirsMerger

type File

type File = afero.File

type Fs

type Fs = afero.Fs

type LinkReader

type LinkReader = afero.LinkReader

type Linker

type Linker = afero.Linker

type Lstater

type Lstater = afero.Lstater

type OsFs

type OsFs = afero.OsFs

type Symlinker

type Symlinker = afero.Symlinker

type UnionFile

type UnionFile = afero.UnionFile