gofile

package module
v0.3.0-1618877367297023 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2021 License: MIT Imports: 7 Imported by: 2

README

gorepotemplate

Tricky and fun utilities for Go programs.


GitHub Workflow Status Codecov

Contributor Covenant

Twitter Follow GitHub followers


Getting Started

Prerequisites

Developed with $( go version; ). Go is extremely backwards compatible and semver stable. Nearly any v1.x should work fine.


Installation

To use this repo as a template for your own project:

gh repo create -y --public --template "https://github.com/skeptycal/gorepotemplate"

Clone this repo to test and contribute:

# add repo to $GOPATH (xxxxxx is your computer login username)
go get github.com/xxxxxx/gorepotemplate

cd ${GOPATH}/src/github.com/xxxxxx/gorepotemplate

# test results and coverage info
./go.test.sh

# install as a utility package
go install

Use the Issues and PR templates on the GitHub repo page to contribute.


Basic Usage

This is a copy of the example script available in the cmd/example/gorepotemplate folder:

package main

import "github.com/skeptycal/gorepotemplate"

func main() {
    gorepotemplate.Example()
}

To try it out:

# change to the sample folder
cd cmd/example/gorepotemplate

# run the main.go program
go run ./main.go

# to compile as an executable
go build

Code of Conduct and Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. Please read the Code of Conduct for details before submitting anything.


Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.


Contributors and Inspiration

  • Michael Treanor (GitHub / Twitter) - Initial work, updates, maintainer
  • Francesc Campoy - Inspiration and great YouTube videos!

See also the list of contributors who participated in this project.


License

Licensed under the MIT https://opensource.org/licenses/MIT - see the LICENSE file for details.

Documentation

Overview

Package gofile provides support for file operations.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Copy

func Copy(src, dest string) (int64, error)

func Create

func Create(filename string) io.ReadWriteCloser

Create creates or truncates the named file and returns an opened file as io.ReadCloser.

If the file already exists, it is truncated. If the file does not exist, it is created with mode 0666 (before umask). If successful, methods on the returned File can be used for I/O; the associated file descriptor has mode O_RDWR. If there is an error, it will be of type *PathError.

If the file cannot be created, an error of type *PathError is returned.

Errors are logged if gofile.Err is active.

func CreateSafe

func CreateSafe(filename string) io.ReadWriteCloser

CreateSafe creates the named file and returns an opened file as io.ReadCloser.

If successful, methods on the returned File can be used for I/O; the associated file descriptor has mode O_RDWR.

If the file already exists, nil is returned. Errors are logged if Err is active.

If the file already exists, of an error occurs, it returns nil and an error is sent to Err. If there is an error, it will be of type *PathError.

func Err

func Err(err error) error

Err logs errors and passes them through unchanged.

func InitialCapacity

func InitialCapacity(capacity int64) int

InitialCapacity returns the multiple of 'chunk' one more than needed to accomodate the given capacity.

func IsDir

func IsDir(name string) bool

func Mode

func Mode(file string) os.FileMode

Mode returns the filemode of file.

func PWD

func PWD() string

PWD returns a rooted path name corresponding to the current directory. If the current directory can be reached via multiple paths (due to symbolic links), Getwd may return any one of them.

func Stat

func Stat(file string) os.FileInfo

Stat returns the os.FileInfo for file if it exists. If the file does not exist, nil is returned. Errors are logged if Err is active.

func StatCheck

func StatCheck(filename string) (os.FileInfo, error)

StatCheck returns file information (after symlink evaluation) using os.Stat(). If the file does not exist, is not a regular file, or if the user lacks adequate permissions, an error is returned.

Types

type PathError

type PathError = os.PathError

func NewPathError

func NewPathError(op, path string, err error) *PathError

NewPathError records an error and the operation and file path that caused it.

type PathError struct {
	Op   string
	Path string
	Err  error
}

Directories

Path Synopsis
cmd
dir command
redlog command
Package json implements json serialization and deserialization.
Package json implements json serialization and deserialization.
Package redlogger implements logging to an io.Writer (default stderr) with text wrapped in ANSI escape codes
Package redlogger implements logging to an io.Writer (default stderr) with text wrapped in ANSI escape codes

Jump to

Keyboard shortcuts

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