Skip to main content

Served

Enum Served 

Source
#[non_exhaustive]
pub enum Served { View { paths: Vec<String>, argv: Vec<String>, }, Card { paths: Vec<String>, card: QueryCard, }, Refused { reason: String, }, }
Expand description

Whether a declared query can be served, and by what.

let p = kevy_sql::plan(
    "CREATE TABLE t (id bigint PRIMARY KEY, n bigint);
     CREATE INDEX ON t (n);
     CREATE VIEW big AS SELECT * FROM t WHERE n >= 10;
     CREATE VIEW odd AS SELECT * FROM t WHERE id = 1;",
)?;
assert!(matches!(p.queries[0].served, kevy_sql::Served::View { .. }));
assert_eq!(p.queries[0].served.paths(), Some(&["t.n".to_string()][..]));
assert!(!p.queries[1].served.is_served());

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

View

Served by the engine holding the whole query as a view.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::View { argv, .. } = &p.queries[0].served else { unreachable!() };
assert_eq!(argv[..2], ["VIEW.CREATE", "mine"]);

Fields

§paths: Vec<String>

The table.column paths this query rides, in argv order.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::View { paths, .. } = &p.queries[0].served else { unreachable!() };
assert_eq!(paths, &["orders.user_id"]);
§argv: Vec<String>

The VIEW.CREATE argv.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::View { argv, .. } = &p.queries[0].served else { unreachable!() };
assert_eq!(argv.join(" "), "VIEW.CREATE mine QUERY orders.user_id EQ 7 ORDER BY orders.user_id");
§

Card

Served by a runtime template the application binds and sends.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::Card { card, .. } = &p.queries[1].served else { unreachable!() };
assert_eq!(card.argv[..4], ["IDX.QUERY", "orders.user_id", "EQ", "$1"]);

Fields

§paths: Vec<String>

The table.column paths this query rides, in argv order.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::Card { paths, .. } = &p.queries[1].served else { unreachable!() };
assert_eq!(paths, &["orders.user_id"]);
§card: QueryCard

The query card.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::Card { card, .. } = &p.queries[1].served else { unreachable!() };
assert_eq!((card.name.as_str(), card.params[0].column.as_str()), ("by_user", "user_id"));
§

Refused

Not served, with the compiler’s own refusal — which names the alternative rather than only saying no.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert!(matches!(p.queries[2].served, kevy_sql::Served::Refused { .. }));

Fields

§reason: String

The refusal, verbatim.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let kevy_sql::Served::Refused { reason } = &p.queries[2].served else { unreachable!() };
assert!(reason.ends_with("add: CREATE INDEX ON orders (status)"));

Implementations§

Source§

impl Served

Source

pub fn is_served(&self) -> bool

Whether this query can be served as declared.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
let served: Vec<bool> = p.queries.iter().map(|q| q.served.is_served()).collect();
assert_eq!(served, [true, true, false]);
Source

pub fn paths(&self) -> Option<&[String]>

The table.column paths a served query rides, in argv order; None when it is refused.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert_eq!(p.queries[0].served.paths(), Some(&["orders.user_id".to_string()][..]));
assert_eq!(p.queries[2].served.paths(), None);

Trait Implementations§

Source§

impl Clone for Served

Source§

fn clone(&self) -> Self

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 Debug for Served

Source§

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

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

impl Eq for Served

Source§

impl Hash for Served

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Served

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Served

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, 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.