Skip to main content

TensogramFile

Struct TensogramFile 

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

A handle for reading/writing Tensogram message files.

Supports local files, memory-mapped files (mmap feature), and remote object stores (remote feature) via a unified API.

Implementations§

Source§

impl TensogramFile

Source

pub fn open(path: impl AsRef<Path>) -> Result<TensogramFile, TensogramError>

Source

pub fn open_source( source: impl AsRef<str>, ) -> Result<TensogramFile, TensogramError>

Open a local file or remote URL.

Auto-detects remote URLs (s3://, s3a://, gs://, az://, azure://, http://, https://) when the remote feature is enabled; otherwise treats the source as a local path.

Source

pub fn create(path: impl AsRef<Path>) -> Result<TensogramFile, TensogramError>

Create a new local file for writing (truncates if exists).

Source

pub fn message_count(&self) -> Result<usize, TensogramError>

Source

pub fn append( &mut self, global_metadata: &GlobalMetadata, descriptors: &[(&DataObjectDescriptor, &[u8])], options: &EncodeOptions, ) -> Result<(), TensogramError>

Source

pub fn read_message(&self, index: usize) -> Result<Vec<u8>, TensogramError>

Source

pub fn messages(&self) -> Result<Vec<Vec<u8>>, TensogramError>

👎Deprecated:

Use message_count() + read_message(index) for lazy access

Source

pub fn decode_message( &self, index: usize, options: &DecodeOptions, ) -> Result<(GlobalMetadata, Vec<(DataObjectDescriptor, Vec<u8>)>), TensogramError>

Source

pub fn iter(&self) -> Result<FileMessageIter, TensogramError>

Source

pub fn path(&self) -> Option<&Path>

Source

pub fn source(&self) -> String

Source

pub fn invalidate_offsets(&mut self)

Source

pub fn decode_metadata( &self, msg_idx: usize, ) -> Result<GlobalMetadata, TensogramError>

Source

pub fn decode_descriptors( &self, msg_idx: usize, ) -> Result<(GlobalMetadata, Vec<DataObjectDescriptor>), TensogramError>

Source

pub fn decode_object( &self, msg_idx: usize, obj_idx: usize, options: &DecodeOptions, ) -> Result<(GlobalMetadata, DataObjectDescriptor, Vec<u8>), TensogramError>

Source

pub fn decode_range( &self, msg_idx: usize, obj_idx: usize, ranges: &[(u64, u64)], options: &DecodeOptions, ) -> Result<(DataObjectDescriptor, Vec<Vec<u8>>), TensogramError>

Source

pub fn is_remote(&self) -> bool

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more