Skip to main content

CostEstimate

Struct CostEstimate 

Source
#[non_exhaustive]
pub struct CostEstimate { /* private fields */ }
Expand description

A cost estimate an engine reports to the optimizer, mirroring MySQL’s Cost_estimate.

The first three components are time-consuming costs the optimizer sums to compare access paths: I/O, CPU, and import (remote) cost. The fourth, memory cost, tracks bytes the engine expects to allocate and is kept apart from the time-based total. All four use MySQL’s internal cost units.

Returned as Some from table_scan_cost, index_scan_cost, and read_cost; the shim assembles a Cost_estimate from the components. This is distinct from the opaque crate::sys::CostEstimate, which is a borrowed handle to a live MySQL accumulator the binding cannot construct.

§Examples

use mysql_handler::engine::CostEstimate;

let cost = CostEstimate::new(10.0, 2.0, 0.0, 0.0);
assert_eq!(cost.io_cost(), 10.0);
assert_eq!(cost.cpu_cost(), 2.0);

Implementations§

Source§

impl CostEstimate

Source

pub const fn new( io_cost: f64, cpu_cost: f64, import_cost: f64, mem_cost: f64, ) -> Self

Build a cost estimate from its I/O, CPU, import, and memory components, each in MySQL’s internal cost units.

Source

pub const fn io_cost(&self) -> f64

Cost of the I/O operations the access path performs.

Source

pub const fn cpu_cost(&self) -> f64

Cost of the CPU work the access path performs.

Source

pub const fn import_cost(&self) -> f64

Cost of remote (import) operations the access path performs.

Source

pub const fn mem_cost(&self) -> f64

Memory the access path expects to use, in bytes.

Trait Implementations§

Source§

impl Clone for CostEstimate

Source§

fn clone(&self) -> CostEstimate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CostEstimate

Source§

impl Debug for CostEstimate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CostEstimate

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for CostEstimate

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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