Struct ScanLimits 

pub struct ScanLimits { /* private fields */ }

Optional total-work budgets for streaming COPY row scans.

Unlike Limits, these budgets accumulate work across rows. max_rows counts complete rows evaluated/yielded by the scan. max_decompressed_bytes counts physical decompressed COPY bytes actually consumed by the parser, including field separators, row terminators, and the COPY terminator when consumed. Decoder or buffered-reader lookahead that has not been consumed by the parser does not count, and logical post-unescape field length is not used.

A configured value is inclusive. A row that would make either counter exceed its limit is not exposed to the caller or predicate. ScanLimits::unlimited and Default apply neither budget; applications handling untrusted or very large inputs should choose explicit bounds appropriate to the operation.

Raw byte extraction uses the separate crate::EntryReadLimits budget.

Implementations

impl ScanLimits

pub const fn unlimited() -> Self

Returns scan limits with neither total-work budget enabled.

pub const fn max_rows(self) -> Option<u64>

Returns the inclusive maximum number of complete rows, if configured.

pub const fn max_decompressed_bytes(self) -> Option<u64>

Returns the inclusive maximum parser-consumed decompressed byte count, if configured.

pub const fn with_max_rows(self, value: u64) -> Self

Returns a configuration with a maximum complete-row budget.

A value of N permits exactly N complete rows; the next row is rejected before it is exposed to the caller or predicate.

pub const fn with_max_decompressed_bytes(self, value: u64) -> Self

Returns a configuration with a maximum parser-consumed decompressed-byte budget.

A value of N permits exactly N consumed COPY bytes. Consuming byte N + 1 produces a typed scan resource error before a crossing row is exposed.

Trait Implementations

impl Clone for ScanLimits

fn clone(&self) -> ScanLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScanLimits

impl Debug for ScanLimits

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

Formats the value using the given formatter.

impl Default for ScanLimits

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScanLimits

impl PartialEq for ScanLimits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanLimits