github.com/dtroyer-salad/og2/v2@v2.0.0-20240412154159-c47231610877/content/resolver.go (about)

     1  /*
     2  Copyright The ORAS Authors.
     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  
    16  // Package content provides implementations to access content stores.
    17  package content
    18  
    19  import (
    20  	"context"
    21  
    22  	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
    23  )
    24  
    25  // Resolver resolves reference tags.
    26  type Resolver interface {
    27  	// Resolve resolves a reference to a descriptor.
    28  	Resolve(ctx context.Context, reference string) (ocispec.Descriptor, error)
    29  }
    30  
    31  // Tagger tags reference tags.
    32  type Tagger interface {
    33  	// Tag tags a descriptor with a reference string.
    34  	Tag(ctx context.Context, desc ocispec.Descriptor, reference string) error
    35  }
    36  
    37  // TagResolver provides reference tag indexing services.
    38  type TagResolver interface {
    39  	Tagger
    40  	Resolver
    41  }
    42  
    43  // Untagger untags reference tags.
    44  type Untagger interface {
    45  	// Untag untags the given reference string.
    46  	Untag(ctx context.Context, reference string) error
    47  }