Struct BlobFile 

pub struct BlobFile { /* private fields */ }

A file-like object that represents a blob in a dataset

Implementations

impl BlobFile

pub fn new_inline( dataset: Arc<Dataset>, field_id: u32, row_addr: u64, position: u64, size: u64, ) -> Self

Create a new BlobFile

See crate::dataset::Dataset::take_blobs

pub fn new_dedicated(dataset: Arc<Dataset>, path: Path, size: u64) -> Self

pub fn new_packed( dataset: Arc<Dataset>, path: Path, position: u64, size: u64, ) -> Self

pub async fn new_external( uri: String, size: u64, registry: Arc<ObjectStoreRegistry>, params: Arc<ObjectStoreParams>, ) -> Result<Self>

pub async fn close(&self) -> Result<()>

Close the blob file, releasing any associated resources

pub async fn is_closed(&self) -> bool

Returns true if the blob file is closed

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.

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.

pub async fn seek(&self, new_cursor: u64) -> Result<()>

Seek to a new cursor position in the file

pub async fn tell(&self) -> Result<u64>

Return the current cursor position in the file

pub fn size(&self) -> u64

Return the size of the blob file in bytes

pub fn position(&self) -> u64

pub fn data_path(&self) -> &Path

pub fn kind(&self) -> BlobKind

pub fn uri(&self) -> Option<&str>

Trait Implementations

impl Debug for BlobFile

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

Formats the value using the given formatter.