Documentation ¶
Index ¶
- Constants
- Variables
- func ApplyLayer(dest string, layer ArchiveReader) error
- func ChangesSize(newDir string, changes []Change) int64
- func CmdStream(cmd *exec.Cmd, input io.Reader) (io.ReadCloser, error)
- func CompressStream(dest io.WriteCloser, compression Compression) (io.WriteCloser, error)
- func CopyFileWithTar(src, dst string) (err error)
- func CopyWithTar(src, dst string) error
- func DecompressStream(archive io.Reader) (io.ReadCloser, error)
- func LUtimesNano(path string, ts []syscall.Timespec) error
- func Tar(path string, compression Compression) (io.ReadCloser, error)
- func TarFilter(srcPath string, options *TarOptions) (io.ReadCloser, error)
- func TarUntar(src string, dst string) error
- func Untar(archive io.Reader, dest string, options *TarOptions) error
- func UntarPath(src, dst string) error
- func UtimesNano(path string, ts []syscall.Timespec) error
- type Archive
- type ArchiveReader
- type Change
- type ChangeType
- type Compression
- type FileInfo
- type TarOptions
- type TempArchive
Constants ¶
const ( ChangeModify = iota ChangeAdd ChangeDelete )
Variables ¶
var (
ErrNotImplemented = errors.New("Function not implemented")
)
Functions ¶
func ApplyLayer ¶ added in v0.7.0
func ApplyLayer(dest string, layer ArchiveReader) error
ApplyLayer parses a diff in the standard layer format from `layer`, and applies it to the directory `dest`.
func ChangesSize ¶ added in v0.7.0
func CmdStream ¶
CmdStream executes a command, and returns its stdout as a stream. If the command fails to run or doesn't complete successfully, an error will be returned, including anything written on stderr.
func CompressStream ¶ added in v0.8.1
func CompressStream(dest io.WriteCloser, compression Compression) (io.WriteCloser, error)
func CopyFileWithTar ¶
CopyFileWithTar emulates the behavior of the 'cp' command-line for a single file. It copies a regular file from path `src` to path `dst`, and preserves all its metadata.
If `dst` ends with a trailing slash '/', the final destination path will be `dst/base(src)`.
func CopyWithTar ¶
CopyWithTar creates a tar archive of filesystem path `src`, and unpacks it at filesystem path `dst`. The archive is streamed directly with fixed buffering and no intermediary disk IO.
func DecompressStream ¶ added in v0.7.3
func DecompressStream(archive io.Reader) (io.ReadCloser, error)
func Tar ¶
func Tar(path string, compression Compression) (io.ReadCloser, error)
Tar creates an archive from the directory at `path`, and returns it as a stream of bytes.
func TarFilter ¶
func TarFilter(srcPath string, options *TarOptions) (io.ReadCloser, error)
Tar creates an archive from the directory at `path`, only including files whose relative paths are included in `filter`. If `filter` is nil, then all files are included.
func TarUntar ¶
TarUntar is a convenience function which calls Tar and Untar, with the output of one piped into the other. If either Tar or Untar fails, TarUntar aborts and returns the error.
func Untar ¶
func Untar(archive io.Reader, dest string, options *TarOptions) error
Untar reads a stream of bytes from `archive`, parses it as a tar archive, and unpacks it into the directory at `path`. The archive may be compressed with one of the following algorithms:
identity (uncompressed), gzip, bzip2, xz.
FIXME: specify behavior when target path exists vs. doesn't exist.
Types ¶
type Archive ¶
type Archive io.ReadCloser
func ExportChanges ¶ added in v0.7.0
func Generate ¶ added in v0.8.1
Generate generates a new archive from the content provided as input.
`files` is a sequence of path/content pairs. A new file is added to the archive for each pair. If the last pair is incomplete, the file is created with an empty content. For example:
Generate("foo.txt", "hello world", "emptyfile")
The above call will return an archive with 2 files:
- ./foo.txt with content "hello world"
- ./empty with empty content
FIXME: stream content instead of buffering FIXME: specify permissions and other archive metadata
type ArchiveReader ¶ added in v0.8.1
type Change ¶ added in v0.7.0
type Change struct { Path string Kind ChangeType }
func ChangesDirs ¶ added in v0.7.0
Compare two directories and generate an array of Change objects describing the changes
type ChangeType ¶ added in v0.7.0
type ChangeType int
type Compression ¶
type Compression int
const ( Uncompressed Compression = iota Bzip2 Gzip Xz )
func DetectCompression ¶
func DetectCompression(source []byte) Compression
func (*Compression) Extension ¶
func (compression *Compression) Extension() string
type FileInfo ¶ added in v0.7.0
type FileInfo struct {
// contains filtered or unexported fields
}
type TarOptions ¶ added in v0.7.0
type TarOptions struct { Includes []string Compression Compression }
type TempArchive ¶
func NewTempArchive ¶
func NewTempArchive(src Archive, dir string) (*TempArchive, error)
NewTempArchive reads the content of src into a temporary file, and returns the contents of that file as an archive. The archive can only be read once - as soon as reading completes, the file will be deleted.