Documentation
¶
Overview ¶
Package filesystem handles the opening and reading of text files.
Index ¶
- Constants
- Variables
- func AddZip(name string, z *zip.Writer) error
- func Clean(name string)
- func Columns(r io.Reader, lb LB) (int, error)
- func Controls(r io.Reader) (int, error)
- func DirExpansion(name string) string
- func IsPipe() bool
- func LineBreak(r LB, extraInfo bool) string
- func Lines(r io.Reader, lb LB) (int, error)
- func Read(name string) ([]byte, error)
- func ReadAllBytes(name string) ([]byte, error)
- func ReadChunk(name string, chars int) ([]byte, error)
- func ReadColumns(name string) (int, error)
- func ReadControls(name string) (int, error)
- func ReadLine(name string, lb nl.LineBreaks) (string, error)
- func ReadLineBreaks(name string) ([2]rune, error)
- func ReadLines(name string) (int, error)
- func ReadPipe() ([]byte, error)
- func ReadRunes(name string) (int, error)
- func ReadTail(name string, offset int) ([]byte, error)
- func ReadText(name string) (string, error)
- func ReadWords(name string) (int, error)
- func Runes(r io.Reader) (int, error)
- func SaveTemp(name string, b ...byte) (string, error)
- func Tar(name string, files ...string) error
- func Touch(name string) (string, error)
- func UniqueName(name string) (string, error)
- func Word(s string) bool
- func Words(r io.Reader) (int, error)
- func WordsEBCDIC(r io.Reader) (int, error)
- func Write(name string, b ...byte) (written int, path string, err error)
- type Files
- type LB
- type Zip
Examples ¶
Constants ¶
const ( // Linefeed is a Linux/macOS line break. Linefeed rune = 10 // CarriageReturn is a partial line break for Windows/DOS. CarriageReturn rune = 13 // NewLine EBCDIC control. NewLine rune = 21 // NextLine EBCDIC control in UTF-8 documents. NextLine rune = 133 )
Variables ¶
var ( ErrNotFound = errors.New("cannot find the file or sample file") ErrStdErr = errors.New("failed to print to stderr") )
ErrStdErr could not print to stderr.
var ErrLB = errors.New("linebreak runes cannot be empty")
Functions ¶
func Clean ¶
func Clean(name string)
Clean removes the named file or directory.
Example ¶
package main
import (
"log"
"github.com/bengarrett/retrotxtgo/lib/filesystem"
)
func main() {
path, err := filesystem.SaveTemp("examplesave.txt", []byte("hello world")...)
if err != nil {
filesystem.Clean(path)
log.Fatal(err)
}
filesystem.Clean(path)
}
Output:
func DirExpansion ¶
DirExpansion returns the absolute directory path from a named path using shell-like expansions. It currently supports limited Bash tilde, shell dot and double dot syntax.
func IsPipe ¶
func IsPipe() bool
IsPipe determines if Stdin (standard input) is piped from another command.
func ReadAllBytes ¶
ReadAllBytes reads the named file and returns the content as a byte array. Create a word and random character generator to make files larger than 64k.
func ReadColumns ¶
ReadColumns counts the number of characters used per line in the named file.
func ReadControls ¶
ReadControls counts the number of ANSI escape sequences in the named file.
func ReadLine ¶
func ReadLine(name string, lb nl.LineBreaks) (string, error)
ReadLine reads a named file location or a named temporary file and returns its content.
func ReadLineBreaks ¶ added in v0.0.31
ReadLineBreaks scans the named file for the most commonly used line break method.
func ReadPipe ¶
ReadPipe reads data piped by the operating system's STDIN. If no data is detected the program will exit.
func ReadTail ¶
ReadTail reads the named file from the offset position relative to the end of the file.
func ReadText ¶
ReadText reads a named file location or a named temporary file and returns its content.
func Tar ¶ added in v0.0.31
Tar add files to a named tar file archive.
Example ¶
package main
import (
"fmt"
"log"
"os"
"github.com/bengarrett/retrotxtgo/lib/filesystem"
"github.com/bengarrett/retrotxtgo/lib/internal/tmp"
)
func main() {
tmpTar := tmp.File("tar_test.tar")
tmpFile, err := filesystem.SaveTemp(tmpTar, []byte("x")...)
if err != nil {
log.Fatal(err)
}
defer os.Remove(tmpFile)
if err = filesystem.Tar(tmpTar, tmpFile); err != nil {
log.Print(err)
return
}
f, err := os.Stat(tmpFile)
if err != nil {
log.Print(err)
return
}
fmt.Printf("%s, %d", f.Name(), f.Size())
}
Output: tar_test.tar, 1536
func UniqueName ¶ added in v0.0.31
UniqueName confirms the file name doesn't conflict with an existing file. If there is a conflict, a new incremental name will be returned.
Example ¶
package main
import (
"fmt"
"log"
"os"
"path/filepath"
"github.com/bengarrett/retrotxtgo/lib/filesystem"
"github.com/bengarrett/retrotxtgo/lib/internal/tmp"
)
func main() {
name := "retrotxtgo_uniquetest.txt"
// Create a temporary 1 byte file in the temporary directory
tmpFile, err := filesystem.SaveTemp(tmp.File(name), []byte("x")...)
if err != nil {
log.Fatal(err)
}
defer os.Remove(tmpFile)
// Use UniqueName to find a new unique filename
// so not to conflict with the previously saved file
u, err := filesystem.UniqueName(tmpFile)
if err != nil {
log.Print(err)
return
}
// In Linux the new name will be retrotxtgo_uniquetest_1.txt
// In Windows the name be retrotxtgo_uniquetest (1).txt
newName := filepath.Base(u)
// As the new unique names vary based on the host operating system
// Compare the name lengths to confirm the creation of a new filename
unique := bool(len(newName) > len(name))
fmt.Print(unique)
}
Output: true
func Word ¶ added in v0.0.38
Word scans the content of a word for characters that are not digits, letters or punctuation and if discovered returns false. If a space or line break is encountered the scan will end.
func WordsEBCDIC ¶ added in v0.0.31
WordsEBCDIC counts the number of spaced words in the EBCDIC encoded reader interface.
Example ¶
package main
import (
"bytes"
"fmt"
"log"
"github.com/bengarrett/retrotxtgo/lib/filesystem"
"github.com/bengarrett/retrotxtgo/static"
)
func main() {
b, err := static.File.ReadFile("text/cp037.txt")
if err != nil {
log.Fatal(err)
}
nr := bytes.NewReader(b)
words, err := filesystem.WordsEBCDIC(nr)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%d words", words)
}
Output: 16 words
Types ¶
type LB ¶ added in v0.0.31
type LB [2]rune
LB is the text line break control represented as 2 runes.
func LineBreaks ¶ added in v0.0.31
LineBreaks will try to guess the line break representation as a 2 byte value. A guess of Unix will return [10, 0], Windows [13, 10], otherwise a [0, 0] value is returned.
type Zip ¶ added in v0.0.31
type Zip struct {
// Zip path and filename.
Name string
// Root path of the directory to archive.
Root string
// Comment to embed.
Comment string
// Overwrite an existing named zip file if encountered.
Overwrite bool
// Quiet suppresses all non-error messages.
Quiet bool
}
Zip archive details.
Example ¶
package main
import (
"fmt"
"log"
"os"
"path"
"github.com/bengarrett/retrotxtgo/lib/filesystem"
"github.com/bengarrett/retrotxtgo/lib/internal/tmp"
)
func main() {
// Create a temporary directory
tmpZip := tmp.File("retrotxtgo_zip_directory_test")
err := os.MkdirAll(tmpZip, 0o755)
if err != nil {
log.Fatal(err)
}
defer os.RemoveAll(tmpZip)
// Create a temporary 1 byte file in the temporary directory
tmpFile, err := filesystem.SaveTemp(path.Join(tmpZip, "temp.zip"), []byte("x")...)
if err != nil {
log.Print(err)
return
}
defer os.Remove(tmpFile)
// Initialize the Zip archive file
name := tmp.File("exampleZip.zip")
zip := filesystem.Zip{
Name: name,
Root: tmpZip,
Comment: "",
Overwrite: true,
Quiet: true,
}
// Create the Zip archive file
if err = zip.Create(); err != nil {
log.Print(err)
return
}
// Check the Zip archive exists
s, err := os.Stat(name)
if err != nil {
log.Print(err)
return
}
fmt.Printf("%s, %d", s.Name(), s.Size())
}
Output: exampleZip.zip, 149
Source Files
Directories