io

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• func CopyAll(src, dst string) (err error)
• func CopyDir(srcDir, dstDir string, copyMode Mode) (err error)
• func CopyFile(src, dst string) (err error)
• func CopyPath(srcPath, dstPath string, f os.FileInfo, copyMode Mode) error
• func CopyRegular(srcPath, dstPath string, fileInfo os.FileInfo) error
• func ReadFile(filePath string) ([]byte, error)
• func ReadFileLines(filepath string) ([]string, error)
• func ReadLineAt(readIndex int, byteArray []byte) ([]byte, int)
• func ReadLines(byteArray []byte) []string
• func WriteBytesAt(filepath string, bytes []byte, offset int64) error
• func WriteBytesLine(buf *bytes.Buffer, bytes []byte) error
• func WriteFile(filePath string, content []byte, appended bool) error
• func WriteFileLine(filePath string, words []string, appended bool) (err error)
• func WriteFileLines(filePath string, lines []string, appended bool) (err error)
• func WriteLine(buf *bytes.Buffer, words ...string) error
• func WriteReader(filepath string, r io.Reader) error
• func WriteReaderAt(filepath string, r io.Reader, offset, length int64) error
• type Mode

Functions

func CopyAll

func CopyAll(src, dst string) (err error)

func CopyDir

func CopyDir(srcDir, dstDir string, copyMode Mode) (err error)

func CopyFile

func CopyFile(src, dst string) (err error)

func CopyPath

func CopyPath(srcPath, dstPath string, f os.FileInfo, copyMode Mode) error

func CopyRegular

func CopyRegular(srcPath, dstPath string, fileInfo os.FileInfo) error

func ReadFile

func ReadFile(filePath string) ([]byte, error)

ReadFile read data from file

func ReadFileLines

func ReadFileLines(filepath string) ([]string, error)

ReadFileLines read line from file divide with \n

func ReadLineAt

func ReadLineAt(readIndex int, byteArray []byte) ([]byte, int)

func ReadLines

func ReadLines(byteArray []byte) []string

ReadLines read line from byteArray divide with \n

func WriteBytesAt

func WriteBytesAt(filepath string, bytes []byte, offset int64) error

func WriteBytesLine

func WriteBytesLine(buf *bytes.Buffer, bytes []byte) error

WriteBytesLine write bytes to buffer, terminate with newline

func WriteFile

func WriteFile(filePath string, content []byte, appended bool) error

func WriteFileLine

func WriteFileLine(filePath string, words []string, appended bool) (err error)

WriteLine join all words with spaces, terminate with newline and write to file.

func WriteFileLines

func WriteFileLines(filePath string, lines []string, appended bool) (err error)

WriteLine join all line to file.

func WriteLine

func WriteLine(buf *bytes.Buffer, words ...string) error

WriteLine join all words with spaces, terminate with newline and write to buff.

func WriteReader

func WriteReader(filepath string, r io.Reader) error

func WriteReaderAt

func WriteReaderAt(filepath string, r io.Reader, offset, length int64) error

Types

type Mode

type Mode int

Mode indicates whether to use hardlink or copy content

const (
	// Content creates a new file, and copies the content of the file
	Content Mode = iota
	// Hardlink creates a new hardlink to the existing file
	Hardlink
)