Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 AufsConvertWhiteout

    func AufsConvertWhiteout(_ *tar.Header, _ string) (bool, error)

      AufsConvertWhiteout converts whiteout files for aufs.

      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 OverlayConvertWhiteout

        func OverlayConvertWhiteout(hdr *tar.Header, path string) (bool, error)

          OverlayConvertWhiteout converts whiteout files for overlay.

          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 WithConvertWhiteout

              func WithConvertWhiteout(c ConvertWhiteout) ApplyOpt

                WithConvertWhiteout uses the convert function to convert the whiteout files.

                func WithFilter

                func WithFilter(f Filter) ApplyOpt

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

                  func WithParents

                  func WithParents(p []string) ApplyOpt

                    WithParents provides parent directories for resolving inherited attributes directory from the filesystem. Inherited attributes are searched from first to last, making the first element in the list the most immediate parent directory. NOTE: When applying to a filesystem which supports CoW, file attributes should be inherited by the filesystem.

                    type ApplyOptions

                    type ApplyOptions struct {
                    	Filter          Filter          // Filter tar headers
                    	ConvertWhiteout ConvertWhiteout // Convert whiteout files
                    	Parents         []string        // Parent directories to handle inherited attributes without CoW
                    	// contains filtered or unexported fields
                    }

                      ApplyOptions provides additional options for an Apply operation

                      type ConvertWhiteout

                      type ConvertWhiteout func(*tar.Header, string) (bool, error)

                        ConvertWhiteout converts whiteout files from the archive

                        type Filter

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

                          Filter specific files from the archive

                          Directories

                          Path Synopsis