file

Documentation

Overview

Package file contains utilities for operating on files.

Index

• func Append(name string, content []byte) error
• func Compress(name string, w io.Writer) io.WriteCloser
• func Copy(oldpath, newpath string) error
• func Create(name string) error
• func Decompress(name string, r io.Reader) (io.ReadCloser, error)
• func DownloadWithCache(ctx context.Context, cacheDir, src, dest string, mode fs.FileMode, quiet bool) error
• func DownloadWithCacheAndExtract(ctx context.Context, cacheDir, src, dest string, match string, ...) error
• func Exists(name string) bool
• func MkdirAll(name string) error
• func Open(name string) (io.WriteCloser, error)
• func Read(name string) ([]byte, error)
• func Remove(name string) error
• func RemoveAll(name string) error
• func Rename(oldpath, newpath string) error
• func Write(name string, content []byte) error
• func WriteWithMode(name string, content []byte, mode os.FileMode) error

Functions

func Append

func Append(name string, content []byte) error

Append appends content to a file.

func Compress

func Compress(name string, w io.Writer) io.WriteCloser

Compress compresses a writer

func Copy

func Copy(oldpath, newpath string) error

Copy copies a file from src to dst.

func Create

func Create(name string) error

Create creates a file.

func Decompress

func Decompress(name string, r io.Reader) (io.ReadCloser, error)

Decompress decompresses a reader It will return a raw reader if the reader is not compressed

func DownloadWithCache

func DownloadWithCache(ctx context.Context, cacheDir, src, dest string, mode fs.FileMode, quiet bool) error

DownloadWithCache downloads the src file to the dest file.

func DownloadWithCacheAndExtract

func DownloadWithCacheAndExtract(ctx context.Context, cacheDir, src, dest string, match string, mode fs.FileMode, quiet bool, clean bool) error

DownloadWithCacheAndExtract downloads the src file to the dest file, and extract it to the dest directory.

func Exists

func Exists(name string) bool

Exists checks if a file exists.

func MkdirAll

func MkdirAll(name string) error

MkdirAll creates a directory.

func Open

func Open(name string) (io.WriteCloser, error)

Open opens/creates a file for writing.

func Read

func Read(name string) ([]byte, error)

Read reads the content of a file.

func Remove

func Remove(name string) error

Remove removes a file.

func RemoveAll

func RemoveAll(name string) error

RemoveAll removes a directory and all its contents.

func Rename

func Rename(oldpath, newpath string) error

Rename renames a file.

func Write

func Write(name string, content []byte) error

Write writes content to a file.

func WriteWithMode

func WriteWithMode(name string, content []byte, mode os.FileMode) error

WriteWithMode writes content to a file with the given mode.