Documentation
¶
Overview ¶
Package offsetrange defines a restriction and restriction tracker for offset ranges. An offset range is just a range, with a start and end, that can begin at an offset, and is commonly used to represent byte ranges for files or indices for iterable containers.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Restriction ¶
type Restriction struct {
Start, End int64 // Half-closed interval with boundaries [start, end).
}
type Tracker ¶
type Tracker struct {
Rest Restriction
Claimed int64 // Tracks the last claimed position.
Stopped bool // Tracks whether TryClaim has already indicated to stop processing elements for
// any reason.
Err error
}
Tracker tracks a restriction that can be represented as a range of integer values, for example for byte offsets in a file, or indices in an array. Note that this tracker makes no assumptions about the positions of blocks within the range, so users must handle validation of block positions if needed.
func NewTracker ¶
func NewTracker(rest Restriction) *Tracker
NewTracker is a constructor for an Tracker given a start and end range.
func (*Tracker) GetError ¶
IsDone returns true if the most recent claimed element is past the end of the restriction.
func (*Tracker) GetProgress ¶
GetProgress reports progress based on the claimed size and unclaimed sizes of the restriction.
func (*Tracker) IsDone ¶
IsDone returns true if the most recent claimed element is past the end of the restriction.
func (*Tracker) TryClaim ¶
TryClaim accepts an int64 position and successfully claims it if that position is greater than the previously claimed position and less than the end of the restriction. Note that the Tracker is not considered done until a position >= tracker.end tries to be claimed, at which point this method signals to end processing.
Source Files