pub struct BlobFile { /* private fields */ }Expand description
A file-like object that represents a blob in a dataset
Implementations§
Source§impl BlobFile
impl BlobFile
Sourcepub fn new_inline(
object_store: Arc<ObjectStore>,
path: Path,
position: u64,
size: u64,
) -> Self
pub fn new_inline( object_store: Arc<ObjectStore>, path: Path, position: u64, size: u64, ) -> Self
Create an inline blob reader backed by a data file.
This constructor assumes the caller has already resolved multi-base routing (base-aware object store and file path). It does not inspect dataset metadata.
§Parameters
object_store- The store that ownspath; reads are issued against this store.path- Full path to the data file containing inline blob bytes.position- Byte offset of the blob payload inside the data file.size- Blob payload length in bytes.
Sourcepub fn new_dedicated(
object_store: Arc<ObjectStore>,
path: Path,
size: u64,
) -> Self
pub fn new_dedicated( object_store: Arc<ObjectStore>, path: Path, size: u64, ) -> Self
Create a dedicated blob reader backed by a sidecar .blob file.
Dedicated blobs occupy an entire sidecar file, so the logical read starts
at offset 0 and spans size bytes.
§Parameters
object_store- The store that ownspath; reads are issued against this store.path- Full path to the dedicated sidecar blob file.size- Total byte length to expose from the sidecar file.
Sourcepub fn new_packed(
object_store: Arc<ObjectStore>,
path: Path,
position: u64,
size: u64,
) -> Self
pub fn new_packed( object_store: Arc<ObjectStore>, path: Path, position: u64, size: u64, ) -> Self
Create a packed blob reader for a slice inside a shared sidecar .blob file.
Packed blobs share one sidecar file; this constructor exposes only the
[position, position + size) range that belongs to a single row.
§Parameters
object_store- The store that ownspath; reads are issued against this store.path- Full path to the packed sidecar blob file.position- Start offset of this blob within the packed sidecar.size- Blob payload length in bytes.
Sourcepub fn new_external(
object_store: Arc<ObjectStore>,
path: Path,
uri: String,
position: u64,
size: u64,
) -> Self
pub fn new_external( object_store: Arc<ObjectStore>, path: Path, uri: String, position: u64, size: u64, ) -> Self
Create an external blob reader backed by a caller-resolved object location.
External blobs are identified by a URI in metadata, but actual reads happen against a concrete store/path pair resolved by the caller. This keeps URI resolution (which may be async) outside of the constructor.
§Parameters
object_store- The resolved store used to open and readpath.path- The resolved object path that contains external blob bytes.uri- The original URI recorded in blob metadata for round-tripping.position- Start offset of the blob payload in the external object.size- Number of bytes exposed fromposition.
Sourcepub async fn close(&self) -> Result<()>
pub async fn close(&self) -> Result<()>
Close the blob file, releasing any associated resources
Sourcepub async fn read_range(&self, range: Range<u64>) -> Result<Bytes>
pub async fn read_range(&self, range: Range<u64>) -> Result<Bytes>
Read a byte range relative to the beginning of this blob without changing the cursor.
The provided range is interpreted in blob-local coordinates, not object
coordinates. Empty ranges are allowed. This method is intended for random
access callers that want deterministic range semantics instead of the
stateful file-like cursor used by Self::read and Self::read_up_to.
Sourcepub async fn read_ranges(&self, ranges: &[Range<u64>]) -> Result<Vec<Bytes>>
pub async fn read_ranges(&self, ranges: &[Range<u64>]) -> Result<Vec<Bytes>>
Read multiple ranges relative to the beginning of this blob without changing the cursor.
Empty ranges are allowed and yield empty buffers. The result order always matches the input order, even though the underlying physical requests may be reordered, coalesced, or split for efficiency.
Sourcepub async fn read(&self) -> Result<Bytes>
pub async fn read(&self) -> Result<Bytes>
Read the entire blob file from the current cursor position to the end of the file
After this call the cursor will be pointing to the end of the file.
Sourcepub async fn read_up_to(&self, len: usize) -> Result<Bytes>
pub async fn read_up_to(&self, len: usize) -> Result<Bytes>
Read up to len bytes from the current cursor position
After this call the cursor will be pointing to the end of the read data.
Sourcepub async fn seek(&self, new_cursor: u64) -> Result<()>
pub async fn seek(&self, new_cursor: u64) -> Result<()>
Seek to a new cursor position in the file
pub fn position(&self) -> u64
pub fn data_path(&self) -> &Path
pub fn kind(&self) -> BlobKind
pub fn uri(&self) -> Option<&str>
Trait Implementations§
Auto Trait Implementations§
impl Freeze for BlobFile
impl !RefUnwindSafe for BlobFile
impl Send for BlobFile
impl Sync for BlobFile
impl Unpin for BlobFile
impl UnsafeUnpin for BlobFile
impl !UnwindSafe for BlobFile
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.