blob: 94c256194d783834278bbabf5e000806390b583f [file] [log] [blame]
// Copyright (C) 2015 The Android Open Source Project
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package memory
import (
// Slice is the interface for a data source that can be resolved to a byte slice
// with Get, or 'sliced' to a subset of the data source.
type Slice interface {
// Get resolves all the bytes representing the slice.
Get(d database.Database, l log.Logger) ([]byte, error)
// ResourceID returns the identifier of the resource representing the slice,
// creating a new resource if it isn't already backed by one.
ResourceID(d database.Database, l log.Logger) (binary.ID, error)
// Size returns the number of bytes that would be returned by calling Get.
Size() uint64
// Slice returns a new Slice referencing a subset range of the data.
// The range r is relative to the base of the Slice. For example a slice of
// [0, 4] would return a Slice referencing the first 5 bytes of this Slice.
// Attempting to slice outside the range of this Slice will result in a
// panic.
Slice(r Range) Slice
// ValidRanges returns the list of slice-relative memory ranges that contain
// valid (non-zero) data that can be read with Get.
ValidRanges() RangeList