1 // Copyright 2018 Google LLC All Rights Reserved. 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 package v1 16 17 import ( 18 "github.com/google/go-containerregistry/pkg/v1/types" 19 ) 20 21 // ImageIndex defines the interface for interacting with an OCI image index. 22 type ImageIndex interface { 23 // MediaType of this image's manifest. 24 MediaType() (types.MediaType, error) 25 26 // Digest returns the sha256 of this index's manifest. 27 Digest() (Hash, error) 28 29 // Size returns the size of the manifest. 30 Size() (int64, error) 31 32 // IndexManifest returns this image index's manifest object. 33 IndexManifest() (*IndexManifest, error) 34 35 // RawManifest returns the serialized bytes of IndexManifest(). 36 RawManifest() ([]byte, error) 37 38 // Image returns a v1.Image that this ImageIndex references. 39 Image(Hash) (Image, error) 40 41 // ImageIndex returns a v1.ImageIndex that this ImageIndex references. 42 ImageIndex(Hash) (ImageIndex, error) 43 } 44