fsio

package module

v0.6.0 Latest Latest Go to latest Published: Nov 9, 2021 License: MIT Imports: 4 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nehemming/fsio

Links

Open Source Insights

README ¶

fsio

File system io support functions that support "~" HOME paths

Installation
Features
Contributing
License

Status

Installation

go get -u https://github.com/nehemming/fsio

or clone this repo to your local machine using

git clone https://github.com/nehemming/fsio

This project requires Go 1.15 or newer and supports modules.

Key features

Support functions to help interact with file systems
Supports expansion of paths starting with ~
Create nested directories with ~ support
Read and write files to / from buffers with ~ support
Support expanding file paths relative to another file

Acknowledgments

Mitchell Hashimoto for go-homedir.

Contributing

We would welcome contributions to this project. Please read our CONTRIBUTION file for further details on how you can participate or report any issues.

License

MIT

Documentation ¶

Overview ¶

Package fsio provides so file system helper functions and types

Index ¶

func Chdir(dir string) error
func CreateFileDirectory(filename string, dirMode os.FileMode) error
func ExpandFilePath(path string) (string, error)
func MakeAbsFromRelativeToFile(path, relFile string) (string, error)
func ReadFileFromPath(filename string) ([]byte, error)
func WriteFileToPath(filename string, buf []byte, modes FileModes) error
type FileModes
- func NewFileModes() FileModes

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Chdir ¶ added in v0.6.0

func Chdir(dir string) error

Chdir changes the current working directory to the named directory. Directory paths starting with ~ will be expanded relative to the home folder.

func CreateFileDirectory ¶

func CreateFileDirectory(filename string, dirMode os.FileMode) error

CreateFileDirectory creates a file's parent directories as necessary.

func ExpandFilePath ¶

func ExpandFilePath(path string) (string, error)

ExpandFilePath expadas a file path to an absolute path. This function handles home directory '~' specifications.

func MakeAbsFromRelativeToFile ¶

func MakeAbsFromRelativeToFile(path, relFile string) (string, error)

MakeAbsFromRelativeToFile makes path into an absolute path, using relfile as sibling file location to the relative base of the path.

func ReadFileFromPath ¶

func ReadFileFromPath(filename string) ([]byte, error)

ReadFileFromPath expands the directory path and then reads the file specified.

func WriteFileToPath ¶

func WriteFileToPath(filename string, buf []byte, modes FileModes) error

WriteFileToPath writes a file to the filename specified. Function expand the path (including ~ substitution) and creates as necessary the parent directoried.

Types ¶

type FileModes ¶

type FileModes struct {
	FileMode os.FileMode
	DirMode  os.FileMode
}

FileModes contains filer and director permissions.

func NewFileModes ¶

func NewFileModes() FileModes

NewFileModes creates a new FileModes struct with default file permissions.

Source Files ¶

View all Source files

directory.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL