Struct Segment 

pub struct Segment {
    pub id: SegmentUuid,
    pub type: SegmentType,
    pub scope: SegmentScope,
    pub collection: CollectionUuid,
    pub metadata: Option<Metadata>,
    pub file_path: HashMap<String, Vec<String>>,
}

Fields

id: SegmentUuid

type: SegmentType

scope: SegmentScope

collection: CollectionUuid

metadata: Option<Metadata>

file_path: HashMap<String, Vec<String>>

Implementations

impl Segment

pub fn empty_segment(&self) -> Self

Returns this segment with its identity/metadata preserved but without any on-disk file paths.

pub fn historical_segment_for_version( &self, version: &CollectionVersionInfo, segment_id: SegmentUuid, ) -> Result<Self, String>

pub fn get_shards(&self) -> Result<Vec<SegmentShard>, SegmentShardError>

pub fn prefetch_supported(&self) -> bool

pub fn filepaths_to_prefetch(&self, shard_index: Option<u32>) -> Vec<String>

Returns the file paths that should be prefetched for this segment. If shard_index is None, returns the active shard’s file paths. If shard_index is Some, returns only the file paths for that shard.

pub fn num_shards(&self) -> Result<usize, SegmentShardError>

Returns the number of shards for this segment. Derives from the length of file_path Vecs (all must be equal per the shard count invariant). Returns 1 if no file paths are present.

pub fn clear_shard_file_paths(&mut self, shard_index: u32)

Clears file paths for a specific shard index. This is useful during shard-specific rebuilds where we want to regenerate only one shard’s files while preserving others.

pub fn matches_schema(&self, schema: &Schema) -> Result<(), SchemaMismatchError>

Check that the on-disk file_path shape matches what the collection schema implies. Returns Ok(()) when they agree or the segment is uninitialized (empty file_path). Returns Err(SchemaMismatchError) on the first mismatch detected.

Validates that all file_path keys have the same shard count and that the set of keys present is consistent with the schema.

pub fn extract_prefix_and_id(path: &str) -> Result<(&str, Uuid), Error>

pub fn construct_prefix_path( &self, tenant: &str, database_id: &DatabaseUuid, ) -> String

impl Segment

pub fn new_shard(&self) -> SegmentShard

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl From<Segment> for Segment

fn from(value: Segment) -> Self

Converts to this type from the input type.

impl PartialEq for Segment

fn eq(&self, other: &Segment) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Segment

impl TryFrom<Segment> for Segment

type Error = SegmentConversionError

The type returned in the event of a conversion error.

fn try_from(proto_segment: Segment) -> Result<Self, Self::Error>

Performs the conversion.