Struct FilteredReadOptionsProto 

pub struct FilteredReadOptionsProto {

    pub scan_range_before_filter: Option<U64Range>,
    pub scan_range_after_filter: Option<U64Range>,
    pub with_deleted_rows: bool,
    pub batch_size: Option<u32>,
    pub fragment_readahead: Option<u64>,
    pub fragment_ids: Vec<u64>,
    pub projection: Option<ProjectionProto>,
    pub refine_filter_substrait: Option<Vec<u8>>,
    pub full_filter_substrait: Option<Vec<u8>>,
    pub threading_mode: Option<FilteredReadThreadingModeProto>,
    pub io_buffer_size_bytes: Option<u64>,
    pub filter_schema_ipc: Option<Vec<u8>>,
    pub materialization_readahead_bytes: Option<u64>,
    pub batch_size_bytes: Option<u64>,
}

Serializable form of FilteredReadOptions.

Fields

scan_range_before_filter: Option<U64Range>

scan_range_after_filter: Option<U64Range>

with_deleted_rows: bool

batch_size: Option<u32>

fragment_readahead: Option<u64>

fragment_ids: Vec<u64>

projection: Option<ProjectionProto>

refine_filter_substrait: Option<Vec<u8>>

full_filter_substrait: Option<Vec<u8>>

threading_mode: Option<FilteredReadThreadingModeProto>

io_buffer_size_bytes: Option<u64>

filter_schema_ipc: Option<Vec<u8>>

Arrow IPC schema for decoding Substrait filters (may be wider than projection).

materialization_readahead_bytes: Option<u64>

If present, a nonzero upper bound on bytes reserved by Blob v2 materialization awaiting ordered emission in one scanner execution. Admission follows output order; one oversized output batch may exceed the bound when no other batch is reserved. If absent, Blob v2 materialization has no independent memory bound.

batch_size_bytes: Option<u64>

If present, the scanner-level byte budget for output batches. When set, the file reader uses it as an additional batch boundary alongside the row-based batch_size. This corresponds to FileReaderOptions.batch_size_bytes.

Implementations

impl FilteredReadOptionsProto

pub fn batch_size(&self) -> u32

Returns the value of batch_size, or the default value if batch_size is unset.

pub fn fragment_readahead(&self) -> u64

Returns the value of fragment_readahead, or the default value if fragment_readahead is unset.

pub fn refine_filter_substrait(&self) -> &[u8]

Returns the value of refine_filter_substrait, or the default value if refine_filter_substrait is unset.

pub fn full_filter_substrait(&self) -> &[u8]

Returns the value of full_filter_substrait, or the default value if full_filter_substrait is unset.

pub fn io_buffer_size_bytes(&self) -> u64

Returns the value of io_buffer_size_bytes, or the default value if io_buffer_size_bytes is unset.

pub fn filter_schema_ipc(&self) -> &[u8]

Returns the value of filter_schema_ipc, or the default value if filter_schema_ipc is unset.

pub fn materialization_readahead_bytes(&self) -> u64

Returns the value of materialization_readahead_bytes, or the default value if materialization_readahead_bytes is unset.

pub fn batch_size_bytes(&self) -> u64

Returns the value of batch_size_bytes, or the default value if batch_size_bytes is unset.

Trait Implementations

impl Clone for FilteredReadOptionsProto

fn clone(&self) -> FilteredReadOptionsProto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilteredReadOptionsProto

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

Formats the value using the given formatter.

impl Default for FilteredReadOptionsProto

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FilteredReadOptionsProto

impl Hash for FilteredReadOptionsProto

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for FilteredReadOptionsProto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for FilteredReadOptionsProto

const NAME: &'static str = "FilteredReadOptionsProto"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "lance.datafusion"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for FilteredReadOptionsProto

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilteredReadOptionsProto