Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

oci

package module

Go to main page

Versions in this module

v0

v0.0.13

May 21, 2026

Changes in this version

+ const MaxAnnotationKeyLen

+ const MaxArtifactTypeLen

+ const MaxMediaTypeLen

+ const MediaTypeDockerManifest

+ const MediaTypeDockerManifestList

+ const MediaTypeImageConfig

+ const MediaTypeImageIndex

+ const MediaTypeImageManifest

type Descriptor

+ Annotations map[string]string

+ ArtifactType string

+ Data []byte

+ Digest Digest

+ MediaType string

+ Platform *Platform

+ Size int64

+ URLs []string

+ type IndexOrManifest struct

+ Annotations map[string]string

+ ArtifactType string

+ Config *Descriptor

+ Layers []Descriptor

+ Manifests []Descriptor

+ MediaType string

+ SchemaVersion int

+ Subject *Descriptor

+ func (m IndexOrManifest) MarshalJSON() ([]byte, error)

+ func (m IndexOrManifest) Validate() error

+ type Platform struct

+ Architecture string

+ OS string

+ OSFeatures []string

+ OSVersion string

+ Variant string

v0.0.12

May 16, 2026

v0.0.11

Apr 16, 2026

v0.0.10

Apr 15, 2026

v0.0.9

Apr 15, 2026

v0.0.8

Apr 15, 2026

v0.0.7

Apr 14, 2026

v0.0.6

Apr 3, 2026

v0.0.2

Apr 3, 2026

Changes in this version

+ var ErrBlobUnknown = NewError("blob unknown to registry", "BLOB_UNKNOWN", nil)

+ var ErrBlobUploadInvalid = NewError("blob upload invalid", "BLOB_UPLOAD_INVALID", nil)

+ var ErrBlobUploadUnknown = NewError("blob upload unknown to registry", "BLOB_UPLOAD_UNKNOWN", nil)

+ var ErrDenied = NewError("requested access to the resource is denied", "DENIED", nil)

+ var ErrDigestInvalid = NewError("provided digest did not match uploaded content", "DIGEST_INVALID", nil)

+ var ErrManifestBlobUnknown = NewError("manifest references a manifest or blob unknown to registry", ...)

+ var ErrManifestInvalid = NewError("manifest invalid", "MANIFEST_INVALID", nil)

+ var ErrManifestUnknown = NewError("manifest unknown to registry", "MANIFEST_UNKNOWN", nil)

+ var ErrNameInvalid = NewError("invalid repository name", "NAME_INVALID", nil)

+ var ErrNameUnknown = NewError("repository name not known to registry", "NAME_UNKNOWN", nil)

+ var ErrRangeInvalid = NewError("invalid content range", "RANGE_INVALID", nil)

+ var ErrSizeInvalid = NewError("provided length did not match content length", "SIZE_INVALID", nil)

+ var ErrTooManyRequests = NewError("too many requests", "TOOMANYREQUESTS", nil)

+ var ErrUnauthorized = NewError("authentication required", "UNAUTHORIZED", nil)

+ var ErrUnsupported = NewError("the operation is unsupported", "UNSUPPORTED", nil)

+ func All[T any](it iter.Seq2[T, error]) ([]T, error)

+ func ErrorSeq[T any](err error) iter.Seq2[T, error]

+ func IsValidDigest(d string) bool

+ func IsValidRepoName(repoName string) bool

+ func IsValidTag(tag string) bool

+ func LimitIter[T any](it iter.Seq2[T, error], limit int) iter.Seq2[T, error]

+ func MarshalError(err error) (errorBody []byte, httpStatus int)

+ func SliceSeq[T any](xs []T) iter.Seq2[T, error]

+ func WriteError(w http.ResponseWriter, err error) error

+ type BlobReader interface

+ Descriptor func() Descriptor

+ type BlobWriter interface

+ Cancel func() error

+ ChunkSize func() int

+ Commit func(digest Digest) (Descriptor, error)

+ ID func() string

+ Size func() int64

+ type Deleter interface

+ DeleteBlob func(ctx context.Context, repo string, digest Digest) error

+ DeleteManifest func(ctx context.Context, repo string, digest Digest) error

+ DeleteTag func(ctx context.Context, repo string, name string) error

+ type Descriptor = ocispec.Descriptor

+ type Digest = ociref.Digest

+ type Error interface

+ Code func() string

+ Detail func() json.RawMessage

+ func NewError(msg string, code string, detail json.RawMessage) Error

+ type Extension interface

+ Repositories func(ctx context.Context, startAfter string) iter.Seq2[string, error]

+ type Funcs struct

+ DeleteBlob_ func(ctx context.Context, repo string, digest Digest) error

+ DeleteManifest_ func(ctx context.Context, repo string, digest Digest) error

+ DeleteTag_ func(ctx context.Context, repo string, name string) error

+ GetBlobRange_ func(ctx context.Context, repo string, digest Digest, offset0, offset1 int64) (BlobReader, error)

+ GetBlob_ func(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ GetManifest_ func(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ GetTag_ func(ctx context.Context, repo string, tagName string) (BlobReader, error)

+ MountBlob_ func(ctx context.Context, fromRepo, toRepo string, digest Digest) (Descriptor, error)

+ NewError func(ctx context.Context, methodName, repo string) error

+ PushBlobChunkedResume_ func(ctx context.Context, repo, id string, offset int64, chunkSize int) (BlobWriter, error)

+ PushBlobChunked_ func(ctx context.Context, repo string, chunkSize int) (BlobWriter, error)

+ PushBlob_ func(ctx context.Context, repo string, desc Descriptor, r io.Reader) (Descriptor, error)

+ PushManifest_ func(ctx context.Context, repo string, contents []byte, mediaType string, ...) (Descriptor, error)

+ Referrers_ func(ctx context.Context, repo string, digest Digest, params *ReferrersParameters) iter.Seq2[Descriptor, error]

+ Repositories_ func(ctx context.Context, startAfter string) iter.Seq2[string, error]

+ ResolveBlob_ func(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ ResolveManifest_ func(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ ResolveTag_ func(ctx context.Context, repo string, tagName string) (Descriptor, error)

+ Tags_ func(ctx context.Context, repo string, params *TagsParameters) iter.Seq2[string, error]

+ func (f *Funcs) DeleteBlob(ctx context.Context, repo string, digest Digest) error

+ func (f *Funcs) DeleteManifest(ctx context.Context, repo string, digest Digest) error

+ func (f *Funcs) DeleteTag(ctx context.Context, repo string, name string) error

+ func (f *Funcs) GetBlob(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ func (f *Funcs) GetBlobRange(ctx context.Context, repo string, digest Digest, offset0, offset1 int64) (BlobReader, error)

+ func (f *Funcs) GetManifest(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ func (f *Funcs) GetTag(ctx context.Context, repo string, tagName string) (BlobReader, error)

+ func (f *Funcs) MountBlob(ctx context.Context, fromRepo, toRepo string, digest Digest) (Descriptor, error)

+ func (f *Funcs) PushBlob(ctx context.Context, repo string, desc Descriptor, r io.Reader) (Descriptor, error)

+ func (f *Funcs) PushBlobChunked(ctx context.Context, repo string, chunkSize int) (BlobWriter, error)

+ func (f *Funcs) PushBlobChunkedResume(ctx context.Context, repo, id string, offset int64, chunkSize int) (BlobWriter, error)

+ func (f *Funcs) PushManifest(ctx context.Context, repo string, contents []byte, mediaType string, ...) (Descriptor, error)

+ func (f *Funcs) Referrers(ctx context.Context, repo string, digest Digest, params *ReferrersParameters) iter.Seq2[Descriptor, error]

+ func (f *Funcs) Repositories(ctx context.Context, startAfter string) iter.Seq2[string, error]

+ func (f *Funcs) ResolveBlob(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ func (f *Funcs) ResolveManifest(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ func (f *Funcs) ResolveTag(ctx context.Context, repo string, tagName string) (Descriptor, error)

+ func (f *Funcs) Tags(ctx context.Context, repo string, params *TagsParameters) iter.Seq2[string, error]

+ type HTTPError interface

+ Response func() *http.Response

+ ResponseBody func() []byte

+ StatusCode func() int

+ func NewHTTPError(err error, statusCode int, response *http.Response, body []byte) HTTPError

+ type Interface interface

+ type Lister interface

+ Referrers func(ctx context.Context, repo string, digest Digest, params *ReferrersParameters) iter.Seq2[Descriptor, error]

+ Tags func(ctx context.Context, repo string, params *TagsParameters) iter.Seq2[string, error]

+ type Manifest = ocispec.Manifest

+ type PushManifestParameters struct

+ Digest Digest

+ Tags []string

+ type ReadWriter interface

+ type Reader interface

+ GetBlob func(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ GetBlobRange func(ctx context.Context, repo string, digest Digest, offset0, offset1 int64) (BlobReader, error)

+ GetManifest func(ctx context.Context, repo string, digest Digest) (BlobReader, error)

+ GetTag func(ctx context.Context, repo string, tagName string) (BlobReader, error)

+ ResolveBlob func(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ ResolveManifest func(ctx context.Context, repo string, digest Digest) (Descriptor, error)

+ ResolveTag func(ctx context.Context, repo string, tagName string) (Descriptor, error)

+ type ReferrersParameters struct

+ ArtifactType string

+ type Seq = iter.Seq2[T, error]

+ type TagsParameters struct

+ Limit int

+ StartAfter string

+ type WireError struct

+ Code_ string

+ Detail_ json.RawMessage

+ Message string

+ func (e *WireError) Code() string

+ func (e *WireError) Detail() json.RawMessage

+ func (e *WireError) Error() string

+ func (e *WireError) Is(err error) bool

+ type WireErrors struct

+ Errors []WireError

+ func (e *WireErrors) Error() string

+ func (e *WireErrors) Unwrap() []error

+ type Writer interface

+ MountBlob func(ctx context.Context, fromRepo, toRepo string, digest Digest) (Descriptor, error)

+ PushBlob func(ctx context.Context, repo string, desc Descriptor, r io.Reader) (Descriptor, error)

+ PushBlobChunked func(ctx context.Context, repo string, chunkSize int) (BlobWriter, error)

+ PushBlobChunkedResume func(ctx context.Context, repo, id string, offset int64, chunkSize int) (BlobWriter, error)

+ PushManifest func(ctx context.Context, repo string, contents []byte, mediaType string, ...) (Descriptor, error)