package
0.0.0-20190116145627-8841ed7cc6ed
Repository: https://github.com/openshift/containers-image.git
Documentation: pkg.go.dev

# Functions

NewOptionalBool converts the input bool into either OptionalBoolTrue or OptionalBoolFalse.

# Constants

Compress indicates the layer must be compressed.
Decompress indicates the layer must be decompressed.
OptionalBoolFalse represents the boolean false.
OptionalBoolTrue represents the boolean true.
OptionalBoolUndefined indicates that the OptionalBoolean hasn't been written.
PreserveOriginal indicates the layer must be preserved, ie no compression or decompression.

# Structs

BICLocationReference encapsulates transport-dependent representation of a blob location within a BICTransportScope.
BICReplacementCandidate is an item returned by BlobInfoCache.CandidateLocations.
BICTransportScope encapsulates transport-dependent representation of a “scope” where blobs are or are not present.
BlobInfo collects known information about a blob (layer/config).
DockerAuthConfig contains authorization information for connecting to a registry.
ImageInspectInfo is a set of metadata describing Docker images, primarily their manifest and configuration.
ManifestTypeRejectedError is returned by ImageDestination.PutManifest if the destination is in principle available, refuses specifically this manifest type, but may accept a different manifest type.
ManifestUpdateInformation is a component of ManifestUpdateOptions, named here only to make writing struct literals possible.
ManifestUpdateOptions is a way to pass named optional arguments to Image.UpdatedManifest.
ProgressProperties is used to pass information from the copy code to a monitor which can use the real-time information to produce output or react to changes.
SystemContext allows parameterizing access to implicitly-accessed resources, like configuration files in /etc and users' login state in their home directory.

# Interfaces

BlobInfoCache records data useful for reusing blobs, or substituing equivalent ones, to avoid unnecessary blob copies.
Image is the primary API for inspecting properties of images.
ImageCloser is an Image with a Close() method which must be called by the user.
ImageDestination is a service, possibly remote (= slow), to store components of a single image.
ImageReference is an abstracted way to refer to an image location, namespaced within an ImageTransport.
ImageSource is a service, possibly remote (= slow), to download components of a single image or a named image set (manifest list).
ImageTransport is a top-level namespace for ways to to store/load an image.
UnparsedImage is an Image-to-be; until it is verified and accepted, it only caries its identity and caches manifest and signature blobs.

# Type aliases

LayerCompression indicates if layers must be compressed, decompressed or preserved.
OptionalBool is a boolean with an additional undefined value, which is meant to be used in the context of user input to distinguish between a user-specified value and a default value.