Struct QueryAdmissionPolicy 

pub struct QueryAdmissionPolicy { /* private fields */ }

Read-admission policy attached to one query surface.

Implementations

impl QueryAdmissionPolicy

pub const fn public_read( max_returned_rows: NonZeroU32, max_response_bytes: NonZeroU32, ) -> Self

Build the safe default policy for caller-facing bounded read endpoints.

pub const fn admin_ad_hoc( max_returned_rows: NonZeroU32, max_scanned_rows: NonZeroU64, max_response_bytes: NonZeroU32, ) -> Self

Build a trusted ad-hoc policy with explicit execution budgets.

pub const fn diagnostic_explain() -> Self

Build an EXPLAIN-only policy that cannot execute rows.

pub const fn dev_test_unbounded() -> Self

Build an unbounded test policy for local harnesses only.

pub const fn lane(&self) -> QueryAdmissionLane

Return the lane this policy governs.

pub const fn require_limit(&self) -> bool

Return whether the surface requires caller-visible LIMIT.

pub const fn max_returned_rows(&self) -> Option<NonZeroU32>

Return the maximum rows that may be returned.

pub const fn max_scanned_rows(&self) -> Option<NonZeroU64>

Return the maximum rows that may be scanned.

pub const fn max_response_bytes(&self) -> Option<NonZeroU32>

Return the maximum response bytes.

pub const fn require_index(&self) -> bool

Return whether the selected plan must use an index-backed path.

pub const fn reject_non_zero_offset(&self) -> bool

Return whether this surface rejects non-zero OFFSET execution.

pub const fn allow_full_scan(&self) -> bool

Return whether a full entity scan may execute.

pub const fn allow_materialized_sort(&self) -> bool

Return whether this surface permits materialized ORDER BY execution.

pub const fn max_materialized_rows(&self) -> Option<NonZeroU32>

Return the maximum rows that may be materialized for sort/projection work.

pub const fn max_projection_columns(&self) -> Option<NonZeroU32>

Return the maximum projected columns.

pub const fn grouped(&self) -> GroupedAdmissionPolicy

Return grouped/aggregate budgets.

pub const fn public_caps_are_finite(&self) -> bool

Return whether public-read construction kept the mandatory finite caps.

pub fn evaluate(&self, summary: QueryAdmissionSummary) -> QueryAdmissionSummary

Apply this policy to one already-summarized plan.

Trait Implementations

impl Clone for QueryAdmissionPolicy

fn clone(&self) -> QueryAdmissionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryAdmissionPolicy

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

Formats the value using the given formatter.

impl Eq for QueryAdmissionPolicy

impl PartialEq for QueryAdmissionPolicy

fn eq(&self, other: &QueryAdmissionPolicy) -> 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 StructuralPartialEq for QueryAdmissionPolicy