archive

Documentation

Index

• func Apply(ctx context.Context, root string, r io.Reader, opts ...ApplyOpt) (int64, error)
• func Diff(ctx context.Context, a, b string) io.ReadCloser
• func WriteDiff(ctx context.Context, w io.Writer, a, b string) error
• type ApplyOpt
  • func WithFilter(f Filter) ApplyOpt
• type ApplyOptions
• type Filter

Functions

func Apply

func Apply(ctx context.Context, root string, r io.Reader, opts ...ApplyOpt) (int64, error)

Apply applies a tar stream of an OCI style diff tar. See https://github.com/opencontainers/image-spec/blob/master/layer.md#applying-changesets

func Diff

func Diff(ctx context.Context, a, b string) io.ReadCloser

Diff returns a tar stream of the computed filesystem difference between the provided directories.

Produces a tar using OCI style file markers for deletions. Deleted files will be prepended with the prefix ".wh.". This style is based off AUFS whiteouts. See https://github.com/opencontainers/image-spec/blob/master/layer.md

func WriteDiff

func WriteDiff(ctx context.Context, w io.Writer, a, b string) error

WriteDiff writes a tar stream of the computed difference between the provided directories.

Produces a tar using OCI style file markers for deletions. Deleted files will be prepended with the prefix ".wh.". This style is based off AUFS whiteouts. See https://github.com/opencontainers/image-spec/blob/master/layer.md

Types

type ApplyOpt

type ApplyOpt func(options *ApplyOptions) error

ApplyOpt allows setting mutable archive apply properties on creation

func WithFilter

func WithFilter(f Filter) ApplyOpt

WithFilter uses the filter to select which files are to be extracted.

type ApplyOptions

type ApplyOptions struct {
	Filter Filter // Filter tar headers
}

ApplyOptions provides additional options for an Apply operation

type Filter

type Filter func(*tar.Header) (bool, error)

Filter specific files from the archive