types

Documentation

Index

• type BadPartialRequestError
  • func (e BadPartialRequestError) Error() string
• type ImageDestinationPartial
• type ImageDestinationWithOptions
• type ImageSourceChunk
• type ImageSourceSeekable
• type PutBlobOptions
• type TryReusingBlobOptions

Types

type BadPartialRequestError

type BadPartialRequestError struct {
	Status string
}

BadPartialRequestError is returned by ImageSourceSeekable.GetBlobAt on an invalid request.

func (BadPartialRequestError) Error

func (e BadPartialRequestError) Error() string

type ImageDestinationPartial

type ImageDestinationPartial interface {
	// PutBlobPartial writes contents of stream and returns data representing the result.
	PutBlobPartial(ctx context.Context, stream ImageSourceSeekable, srcInfo publicTypes.BlobInfo, cache publicTypes.BlobInfoCache) (publicTypes.BlobInfo, error)
}

ImageDestinationPartial is a service to store a blob by requesting the missing chunks to a ImageSourceSeekable. This API is experimental and can be changed without bumping the major version number.

type ImageDestinationWithOptions

type ImageDestinationWithOptions interface {
	publicTypes.ImageDestination

	// PutBlobWithOptions is a wrapper around PutBlob.  If
	// options.LayerIndex is set, the blob will be committed directly.
	// Either by the calling goroutine or by another goroutine already
	// committing layers.
	//
	// Please note that TryReusingBlobWithOptions and PutBlobWithOptions
	// *must* be used the together.  Mixing the two with non "WithOptions"
	// functions is not supported.
	PutBlobWithOptions(ctx context.Context, stream io.Reader, blobinfo publicTypes.BlobInfo, options PutBlobOptions) (publicTypes.BlobInfo, error)

	// TryReusingBlobWithOptions is a wrapper around TryReusingBlob.  If
	// options.LayerIndex is set, the reused blob will be recoreded as
	// already pulled.
	//
	// Please note that TryReusingBlobWithOptions and PutBlobWithOptions
	// *must* be used the together.  Mixing the two with non "WithOptions"
	// functions is not supported.
	TryReusingBlobWithOptions(ctx context.Context, blobinfo publicTypes.BlobInfo, options TryReusingBlobOptions) (bool, publicTypes.BlobInfo, error)
}

ImageDestinationWithOptions is an internal extension to the ImageDestination interface.

type ImageSourceChunk

type ImageSourceChunk struct {
	Offset uint64
	Length uint64
}

ImageSourceChunk is a portion of a blob. This API is experimental and can be changed without bumping the major version number.

type ImageSourceSeekable

type ImageSourceSeekable interface {
	// GetBlobAt returns a stream for the specified blob.
	GetBlobAt(context.Context, publicTypes.BlobInfo, []ImageSourceChunk) (chan io.ReadCloser, chan error, error)
}

ImageSourceSeekable is an image source that permits to fetch chunks of the entire blob. This API is experimental and can be changed without bumping the major version number.

type PutBlobOptions

type PutBlobOptions struct {
	// Cache to look up blob infos.
	Cache publicTypes.BlobInfoCache
	// Denotes whether the blob is a config or not.
	IsConfig bool
	// Indicates an empty layer.
	EmptyLayer bool
	// The corresponding index in the layer slice.
	LayerIndex *int
}

PutBlobOptions are used in PutBlobWithOptions.

type TryReusingBlobOptions

type TryReusingBlobOptions struct {
	// Cache to look up blob infos.
	Cache publicTypes.BlobInfoCache
	// Use an equivalent of the desired blob.
	CanSubstitute bool
	// Indicates an empty layer.
	EmptyLayer bool
	// The corresponding index in the layer slice.
	LayerIndex *int
	// The reference of the image that contains the target blob.
	SrcRef reference.Named
}

TryReusingBlobOptions are used in TryReusingBlobWithOptions.