aboutsummaryrefslogtreecommitdiff
path: root/object/store/quarantine.go
blob: b827d843f45a8dcd212ca6b0ddc2c852961cb402 (about) (plain) (blame)
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
package objectstore

// Quarantine is one quarantined write. It is intended to be embedded.
type Quarantine interface {
	// Reader returns the objects written into this quarantine.
	Reader() Reader

	// Promote publishes quarantined writes into their final destination.
	Promote() error

	// Discard abandons quarantined writes.
	Discard() error
}

// ObjectQuarantine represents one quarantined object-wise write.
type ObjectQuarantine interface {
	Quarantine
	ObjectWriter
}

// PackQuarantine represents one quarantined pack-wise write.
type PackQuarantine interface {
	Quarantine
	PackWriter
}

// ObjectQuarantineOptions controls the options for one object quarantine creation.
type ObjectQuarantineOptions struct{}

// PackQuarantineOptions controls the options for one pack quarantine creation.
type PackQuarantineOptions struct{}

// ObjectQuarantiner creates quarantines for object-wise writes.
type ObjectQuarantiner interface {
	BeginObjectQuarantine(opts ObjectQuarantineOptions) (ObjectQuarantine, error)
}

// PackQuarantiner creates quarantines for pack-wise writes.
type PackQuarantiner interface {
	BeginPackQuarantine(opts PackQuarantineOptions) (PackQuarantine, error)
}