README
¶
fsutil
This cross-platform go module provides a lightweight abstraction of common file system methods:
Touch(path string): Like the Unix touch command. Returns a string with the absolute path of the file/directory.Mkdirp(path string): Like the Unix mkdir -p command. Returns a string with the absolute path of the directory.Exists(path string): Returns a boolean indicatingtrueif the path exists andfalseif it does not.Abs(path string): Returns the absolute path as a string. Unlike the native filepath.Abs, this method always returns a string (and only a string, no error). This method does not depend on the existence of the directory. Relative paths are always resolved from the current working directory.Clean(path string): This method ensures an empty directory exists at the specified path.IsFile(path string): Returns a boolean value indicatingtrueif the path resolves to a file andfalseif it does not.IsDirectory(path string): Returns a boolean value indicatingtrueif the path resolves to a directory andfalseif it does not.IsSymlink(path string) bool: Determines if a path is a symbolic link.ReadTextFile(path string): Reads a text file and returns a string.WriteTextFile(path string, content string, <os.FileMode>): Writes a text file from a string. Optionally accepts a file mode.IsReadable(path string) bool: Determines whether the path is readable.IsWritable(path string) bool: Determines whether the path is writable.IsExecutable(path string) bool: Determines whether the path has execute permissions.ByteSize(path string): Determines the size (in bytes) of a file or directory.Size(path string, decimalPlaces int): A "pretty" label for the size of a file or directory. For example,3.14MB.FormatSize(size int64, decimalPlaces int): Pretty-print the byte size, i.e.3.14MB.Copy(source string, target string, ignoreErrors ...bool) error: Copy a file/directory contents. Ignores symlinks. Optionally specifytrueas the last argument to ignore errors.Move(source string, target string, ignoreErrors ...bool) error: Move a file/directory contents. Ignores symlinks. Optionally specifytrueas the last argument to ignore errors.Unzip(source string, target string) error: Unzip a file into the target directory.Zip(source string, target string) error: Zip a file/directory into the target directory/filename.
Example
package main
import (
"github.com/coreybutler/go-fsutil"
)
func main() {
fsutil.Touch("./path/to/test.txt")
}
The code above would create an empty file called test.txt in <<current working directory>>/path/to. If the directory does not exist, it will be created.
For complete details, see the Godoc. Examples are available in the test files.
Notice
This API is stable, but subject to additions. I work on it whenever a "common file system need" comes up in other projects. As a result, the 1.0.X release cycle will continue to receive new feature additions until I consider the API "well-defined". This deviates a tiny bit from traditional semantic versioning, because new "features" are being added in patch releases.
Upon the release of a 1.1.0 version, the API will be considered "well-defined" and will adhere more strictly to semantic versioning practices.
Documentation
¶
Index ¶
- Constants
- func Abs(path string) string
- func ByteSize(path string) (int64, error)
- func Clean(path string)
- func Copy(source string, dest string, ignoreErrors ...bool) error
- func Exists(path string) bool
- func FormatSize(bytesize int64, sigfig ...int) string
- func IsDirectory(path string) bool
- func IsExecutable(filepath string) bool
- func IsFile(path string) bool
- func IsReadable(path string) bool
- func IsSymlink(path string) bool
- func IsWritable(path string) bool
- func LastModified(path string) (time.Time, error)
- func List(directory string, recursive bool, ignore ...string) ([]string, error)
- func ListDirectories(directory string, recursive bool, ignore ...string) ([]string, error)
- func ListFiles(directory string, recursive bool, ignore ...string) ([]string, error)
- func Mkdirp(path string) string
- func Move(source string, dest string, ignoreErrors ...bool) error
- func ReadTextFile(path string) (string, error)
- func Size(path string, sigfig ...int) (string, error)
- func Symlink(target string, name string) error
- func Touch(path string, flags ...interface{}) string
- func Unzip(src string, dest string) error
- func WriteTextFile(path string, content string, args ...interface{}) error
- func Zip(src string, target ...string) error
Constants ¶
const GB float64 = 1024 * MB
GB represents the size of a giggabyte.
const KB float64 = 1024
KB represents the size of a kilobyte.
const MB float64 = 1024 * KB
MB represents the size of a megabyte.
const PB float64 = 1024 * TB
PB represents the size of a petabyte.
const TB float64 = 1024 * GB
TB represents the size of a terabyte.
Variables ¶
This section is empty.
Functions ¶
func Abs ¶
Returns the fully resolved path, even if the path does not exist.
``` fsutil.Abs("./does/not/exist") ``` If the code above was run within `/home/user`, the result would be `/home/user/does/not/exist`.
func Clean ¶
func Clean(path string)
Clean will ensure the specified directory exists. If the directory already exists, all of contents are deleted. If the directory does not exist, it is automatically created.
func FormatSize ¶ added in v1.0.8
FormatSize returns a nicely formatted representation of a number of bytes, such as `3.14MB`
func IsDirectory ¶
IsDirectory determines whether the specified path represents a directory.
func IsExecutable ¶ added in v1.0.9
IsExecutable determines whether the file/directory is executable for the active system user.
func IsReadable ¶
IsReadable determines whether the file/directory is readable for the active system user.
func IsWritable ¶
IsWritable determines whether the file/directory is writable for the active system user.
func LastModified ¶ added in v1.0.8
LastModified identies the last time the path was modified.
func List ¶
Generate a list of path names for the given directory. Optionally provide a list of ignored paths, using [glob](https://en.wikipedia.org/wiki/Glob_%28programming%29) syntax.
func ListDirectories ¶
ListDirectories provides absolute paths of directories only, ignoring files.
func Mkdirp ¶
Mkdirp is the equivalent of [mkdir -p](https://en.wikipedia.org/wiki/Mkdir) It will generate the full directory path if it does not already exist.
func ReadTextFile ¶
ReadTextFile reads a text file and converts results from bytes to a string.
func Touch ¶
Similar to the touch command on *nix, where the file or directory will be created if it does not already exist. Returns the absolute path. The optional second boolean argument will force the method to treat the path as a file instead of a directory (useful when the filename has not extension). An optional 3rd boolean argument will force the method to treat the path as a directory even if a file extension is present.
For example: `fsutil.Touch("./path/to/archive.old", false, true)`
Normally, any file path with an extension is determined to be a file. However; the second argument (`false`) instructs the command to **not** force a file. The third argument (`true`) instructs the command to **treat the path like a directory**.
func WriteTextFile ¶
WriteTextFile writes text to a file (automatically converts string to a byte array). If the path does not exist, it will be created automatically. This is the equivalent of using the Touch() method first, then writing text content to the file.
It is also possible to pass a third argument, a custom permission. By default, os.ModePerm is used.
Types ¶
This section is empty.
Source Files