Struct DataFile 

pub struct DataFile {
    pub path: String,
    pub fields: Vec<i32>,
    pub column_indices: Vec<i32>,
    pub file_major_version: u32,
    pub file_minor_version: u32,
    pub file_size_bytes: CachedFileSize,
    pub base_id: Option<u32>,
}

Lance Data File

A data file is one piece of file storing data.

Fields

path: String

Relative path of the data file to dataset root.

fields: Vec<i32>

The ids of fields in this file.

column_indices: Vec<i32>

The offsets of the fields listed in fields, empty in v1 files

Note that -1 is a possibility and it indices that the field has no top-level column in the file.

Columns that lack a field id may still exist as extra entries in column_indices; such columns are ignored by field-id–based projection. For example, some fields, such as blob fields, occupy multiple columns in the file but only have a single field id.

file_major_version: u32

The major version of the file format used to write this file.

file_minor_version: u32

The minor version of the file format used to write this file.

file_size_bytes: CachedFileSize

The size of the file in bytes, if known.

base_id: Option<u32>

The base path of the datafile, when the datafile is outside the dataset.

Implementations

impl DataFile

pub fn new( path: impl Into<String>, fields: Vec<i32>, column_indices: Vec<i32>, file_major_version: u32, file_minor_version: u32, file_size_bytes: Option<NonZero<u64>>, base_id: Option<u32>, ) -> Self

pub fn new_unstarted( path: impl Into<String>, file_major_version: u32, file_minor_version: u32, ) -> Self

Create a new DataFile with the expectation that fields and column_indices will be set later

pub fn new_legacy_from_fields( path: impl Into<String>, fields: Vec<i32>, base_id: Option<u32>, ) -> Self

pub fn new_legacy( path: impl Into<String>, schema: &Schema, file_size_bytes: Option<NonZero<u64>>, base_id: Option<u32>, ) -> Self

pub fn schema(&self, full_schema: &Schema) -> Schema

pub fn is_legacy_file(&self) -> bool

pub fn validate(&self, base_path: &Path) -> Result<()>

Trait Implementations

impl Clone for DataFile

fn clone(&self) -> DataFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataFile

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

Formats the value using the given formatter.

impl DeepSizeOf for DataFile

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl<'de> Deserialize<'de> for DataFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DataFile> for DataFile

fn from(df: &DataFile) -> Self

Converts to this type from the input type.

impl PartialEq for DataFile

fn eq(&self, other: &DataFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DataFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DataFile> for DataFile

type Error = Error

The type returned in the event of a conversion error.

fn try_from(proto: DataFile) -> Result<Self>

Performs the conversion.

impl Eq for DataFile

impl StructuralPartialEq for DataFile