Struct ObjectCatalog 

pub(crate) struct ObjectCatalog {
    objects: BTreeMap<u64, Vec<FooterEntry>>,
    regions: BTreeMap<RegionId, BTreeMap<u64, FooterEntry>>,
}

Indexes objects by sequence and, per region, the objects that hold entries of that region.

Fields

objects: BTreeMap<u64, Vec<FooterEntry>>

regions: BTreeMap<RegionId, BTreeMap<u64, FooterEntry>>

Implementations

impl ObjectCatalog

pub(crate) fn insert_object( &mut self, object_seq: u64, footer: Vec<FooterEntry>, ) -> Result<()>

Indexes the footer of the object object_seq. Objects may be inserted in any order, which lets recovery index them as it discovers them. Inserting a sequence that is already indexed is rejected, whether or not the footer matches the indexed one. An object without segments holds no entries but still takes its sequence.

pub(crate) fn objects_for_entry_range( &self, region_id: RegionId, start_entry_id: u64, end_entry_id: u64, ) -> Result<Vec<(u64, &FooterEntry)>>

Returns the objects that hold entries of region_id overlapping start_entry_id..=end_entry_id, ordered by object sequence.

pub(crate) fn region_max_entry_id(&self, region_id: RegionId) -> Option<u64>

Returns the largest entry id indexed for region_id.

pub(crate) fn next_object_seq(&self) -> Result<u64>

Returns the sequence to assign to the next object written after recovery.

An empty catalog starts at zero, so the first object of a prefix always takes sequence zero. Otherwise the sequence continues after the largest indexed one, which recovery discovers regardless of insertion order, and is raised further when the largest entry id of a region lies at or above the ids that sequence would assign: ids assigned under the earlier contiguous scheme carry no object information, and every new id of a region must be greater than every id it already has. A sequence at or above OBJECT_SEQ_LIMIT does not fit an entry id and is rejected.

pub(crate) fn objects_in_order( &self, ) -> impl Iterator<Item = (u64, &[FooterEntry])> + '_

Iterates over the indexed objects ordered by object sequence.

Trait Implementations

impl Debug for ObjectCatalog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ObjectCatalog

fn default() -> ObjectCatalog

Returns the “default value” for a type.