summaryrefslogtreecommitdiffstats
path: root/pkg/v1/image.go
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/v1/image.go')
-rw-r--r--pkg/v1/image.go59
1 files changed, 59 insertions, 0 deletions
diff --git a/pkg/v1/image.go b/pkg/v1/image.go
new file mode 100644
index 0000000..8de9e47
--- /dev/null
+++ b/pkg/v1/image.go
@@ -0,0 +1,59 @@
+// Copyright 2018 Google LLC All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1
+
+import (
+ "github.com/google/go-containerregistry/pkg/v1/types"
+)
+
+// Image defines the interface for interacting with an OCI v1 image.
+type Image interface {
+ // Layers returns the ordered collection of filesystem layers that comprise this image.
+ // The order of the list is oldest/base layer first, and most-recent/top layer last.
+ Layers() ([]Layer, error)
+
+ // MediaType of this image's manifest.
+ MediaType() (types.MediaType, error)
+
+ // Size returns the size of the manifest.
+ Size() (int64, error)
+
+ // ConfigName returns the hash of the image's config file, also known as
+ // the Image ID.
+ ConfigName() (Hash, error)
+
+ // ConfigFile returns this image's config file.
+ ConfigFile() (*ConfigFile, error)
+
+ // RawConfigFile returns the serialized bytes of ConfigFile().
+ RawConfigFile() ([]byte, error)
+
+ // Digest returns the sha256 of this image's manifest.
+ Digest() (Hash, error)
+
+ // Manifest returns this image's Manifest object.
+ Manifest() (*Manifest, error)
+
+ // RawManifest returns the serialized bytes of Manifest()
+ RawManifest() ([]byte, error)
+
+ // LayerByDigest returns a Layer for interacting with a particular layer of
+ // the image, looking it up by "digest" (the compressed hash).
+ LayerByDigest(Hash) (Layer, error)
+
+ // LayerByDiffID is an analog to LayerByDigest, looking up by "diff id"
+ // (the uncompressed hash).
+ LayerByDiffID(Hash) (Layer, error)
+}