-
Notifications
You must be signed in to change notification settings - Fork 0
/
instance.go
45 lines (38 loc) · 1.46 KB
/
instance.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Copyright 2018 The LUCI Authors.
//
// 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 pkg
import (
"context"
"io"
"github.com/TriggerMail/luci-go/cipd/client/cipd/fs"
"github.com/TriggerMail/luci-go/cipd/common"
)
// Instance represents an open CIPD package file (with manifest inside).
//
// It owns the underlying raw data source and closes it whenever it is closed
// itself.
type Instance interface {
// Pin identifies package name and concreted instance ID of this package file.
Pin() common.Pin
// Files returns a list of files to deploy with the package.
//
// One of them (named ManifestName) is the manifest file.
Files() []fs.File
// Source returns a reader that reads raw package data.
Source() io.ReadSeeker
// Close can be used to indicate to the storage (filesystem and/or cache)
// layer that this instance is actually bad. The storage layer can then
// evict/revoke, etc. the bad file.
Close(ctx context.Context, corrupt bool) error
}