com.lancedb.lance

Class BlobFile

java.lang.Object

com.lancedb.lance.BlobFile

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BlobFile
extends Object
implements Closeable

BlobFile: a file-like abstraction for a single blob, aligned with Lance Rust/Python semantics. Read-only: methods include read, readUpTo, readRange, seek, tell, size, close. All delegate to JNI.

Usage example (try-with-resources for automatic resource management):

 try (BlobFile blob = dataset.takeBlob()) {
     long size = blob.size();
     byte[] data = blob.read(); // Read all content
     blob.seek(1024);
     byte[] partial = blob.readUpTo(512); // Read 512 bytes from position 1024
 } catch (IOException e) {
     // Handle IO errors
 }
 

Auto-closes after try block, no manual close needed.

Constructor Summary

Constructors

Constructor and Description
BlobFile() Default no-arg constructor used by JNI to attach native handle.

Method Summary

Modifier and Type	Method and Description
void	close() Close BlobFile and release associated resources.
byte[]	read() Read all remaining bytes from current cursor to end.
byte[]	readUpTo(int len) Read up to len bytes from the current cursor.
void	seek(long newCursor) Seek to a new cursor position.
long	size() Return blob size in bytes.
long	tell() Return current cursor position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobFile

public BlobFile()

Default no-arg constructor used by JNI to attach native handle.

Method Detail

read

public byte[] read()
            throws IOException

Read all remaining bytes from current cursor to end.

Throws:

IOException

readUpTo

public byte[] readUpTo(int len)
                throws IOException

Read up to len bytes from the current cursor.

Throws:

IOException

seek

public void seek(long newCursor)
          throws IOException

Seek to a new cursor position.

Throws:

IOException

tell

public long tell()
          throws IOException

Return current cursor position.

Throws:

IOException

size

public long size()

Return blob size in bytes.

close

public void close()
           throws IOException

Close BlobFile and release associated resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException