#[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: QueryCardThe 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: StringThe 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
impl Served
Sourcepub fn is_served(&self) -> bool
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]);Sourcepub fn paths(&self) -> Option<&[String]>
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§
impl Eq for Served
impl StructuralPartialEq for Served
Auto Trait Implementations§
impl Freeze for Served
impl RefUnwindSafe for Served
impl Send for Served
impl Sync for Served
impl Unpin for Served
impl UnsafeUnpin for Served
impl UnwindSafe for Served
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more