Skip to main content

OwnedSegment

Struct OwnedSegment 

Source
pub struct OwnedSegment { /* private fields */ }
Expand description

Owned segment — bytes + parsed metadata in a single struct, no borrow lifetimes. The catalog (v5.1+) holds a Vec<OwnedSegment> for its cold tier so each lookup parses nothing fresh; the lookup / might_contain / scan calls here share the same module-private implementation as SegmentReader.

File I/O lives outside this struct — spg-storage is no_std, so callers (e.g. spg-server) load the segment via std::fs::read and hand the resulting Vec<u8> to OwnedSegment::from_bytes.

Implementations§

Source§

impl OwnedSegment

Source

pub fn from_bytes(bytes: Vec<u8>) -> Result<Self, SegmentError>

Parse and validate a segment from owned bytes. The bytes stay resident inside the returned OwnedSegment for the life of that value. Validation cost is paid once; per- lookup cost is identical to SegmentReader::lookup.

v6.6.2 — accepts both v1 (SPGSEG\x01\x00) and v2 (SPGSEG\x02\x00) magics. A v2 file’s body is transparently unwrapped before the v1 parser runs; the unwrapped v1 bytes become the bytes field, so all downstream readers see a canonical v1 layout. v6.7.1 — also extracts any BRIN sidecar.

Source

pub fn brin_summaries(&self) -> &[BrinSummary]

v6.7.1 — borrow the BRIN per-page summaries when the segment was written with a BRIN sidecar. Empty for v1 segments or v2 without a sidecar.

Source

pub fn meta(&self) -> &SegmentMeta

Source

pub fn codec_version(&self) -> u8

v7.23/v7.27 — the codec version implied by this segment’s inner magic (0 legacy / 46 / 47). Callers thread this into decode_row_body_dense.

Source

pub fn might_contain(&self, key: u64) -> bool

Source

pub fn lookup(&self, key: u64) -> Option<Vec<u8>>

Source

pub fn scan(&self) -> impl Iterator<Item = (u64, Vec<u8>)> + '_

Source

pub fn bytes(&self) -> &[u8]

Raw segment bytes — exposed for callers that want to write the segment back to disk or hand it to a checksum tool. Read-only.

Trait Implementations§

Source§

impl Clone for OwnedSegment

Source§

fn clone(&self) -> OwnedSegment

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OwnedSegment

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.