Skip to main content

Scalar

Enum Scalar 

Source
#[non_exhaustive]
pub enum Scalar { Null, Int(i64), Float(f64), Text(String), Bool(bool), Timestamp(i64), Date(i64), Interval { months: i64, days: i64, micros: i64, }, }
Expand description

A typed scalar value — the closed set the function library speaks.

Deliberately narrower than SQL’s type zoo: kevy’s sql face maps bigint/int → Int, double/numeric-literal → Float, text/varchar → Text, boolean → Bool, and SQL NULL → Null. Types the engine refuses (money, inet, enum, …) never reach this crate.

§Examples

use kevy_scalar::{Scalar, eval};
// NULL is a value here, not an absence, and it PROPAGATES: a strict
// function with a NULL argument answers NULL rather than erroring.
assert_eq!(eval("upper", &[Scalar::Null]).unwrap(), Scalar::Null);
assert_eq!(
    eval("upper", &[Scalar::Text("ada".into())]).unwrap(),
    Scalar::Text("ADA".into())
);

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.
§

Null

SQL NULL. Propagates: any strict function with a NULL argument answers NULL (the null-family module documents its exceptions).

use kevy_scalar::{Scalar, eval};
assert_eq!(eval("lower", &[Scalar::Null])?, Scalar::Null);
assert_eq!(eval("coalesce", &[Scalar::Null, Scalar::Int(1)])?, Scalar::Int(1));
§

Int(i64)

A 64-bit integer.

use kevy_scalar::{Scalar, eval};
assert_eq!(eval("length", &[Scalar::Text("kevy".into())])?, Scalar::Int(4));
assert_eq!(Scalar::Int(-7).render(), "-7");
§

Float(f64)

A 64-bit float. PG’s numeric literals fold through here; the sql face renders results back with PG’s trailing-zero rules.

use kevy_scalar::{Scalar, binop};
let half = binop('/', &Scalar::Float(1.0), &Scalar::Int(2))?;
assert_eq!(half, Scalar::Float(0.5));
assert_eq!(half.render(), "0.5");
§

Text(String)

A UTF-8 string.

use kevy_scalar::{Scalar, eval};
let out = eval("initcap", &[Scalar::Text("hello world".into())])?;
assert_eq!(out, Scalar::Text("Hello World".into()));
§

Bool(bool)

A boolean.

use kevy_scalar::{Scalar, logic_not};
assert_eq!(logic_not(&Scalar::Bool(true))?, Scalar::Bool(false));
assert_eq!(Scalar::Bool(false).render(), "f");
§

Timestamp(i64)

A timestamp (no time zone): microseconds since the Unix epoch. Probe 38’s lesson is baked in: now() and friends must be TYPED, not text — the sql face rewrites them to this variant.

use kevy_scalar::{Scalar, parse_timestamp};
let us = parse_timestamp("1970-01-02 00:00:00").unwrap();
assert_eq!(us, 86_400_000_000);
assert_eq!(Scalar::Timestamp(us).render(), "1970-01-02 00:00:00");
§

Date(i64)

A calendar date: days since the Unix epoch.

use kevy_scalar::{Scalar, binop, parse_date};
let d = Scalar::Date(parse_date("2024-02-28").unwrap());
let next = binop('+', &d, &Scalar::Int(1))?;
assert_eq!(next.render(), "2024-02-29");
§

Interval

An interval in PG’s three-component shape: months, days and microseconds never mix (probe 10’s 1 day - 12 hours stays 1 day -12:00:00 — no normalization across components). Month arithmetic clamps to month ends; the other two are exact.

use kevy_scalar::{Scalar, binop, parse_date};
let jan31 = Scalar::Date(parse_date("2024-01-31").unwrap());
let month = Scalar::Interval { months: 1, days: 0, micros: 0 };
// clamped to the last day of February
assert_eq!(binop('+', &jan31, &month)?.render(), "2024-02-29 00:00:00");

Fields

§months: i64

Whole calendar months (12 per year).

use kevy_scalar::{Scalar, parse_interval};
let (months, _, _) = parse_interval("1 year 2 mons").unwrap();
assert_eq!(months, 14);
let iv = Scalar::Interval { months, days: 0, micros: 0 };
assert_eq!(iv.render(), "1 year 2 mons");
§days: i64

Whole days — separate from micros because PG keeps them separate (visible in rendering and component extraction).

use kevy_scalar::Scalar;
// 1 day minus 12 hours stays as two components
let iv = Scalar::Interval { months: 0, days: 1, micros: -43_200_000_000 };
assert_eq!(iv.render(), "1 day -12:00:00");
§micros: i64

Sub-day remainder in microseconds.

use kevy_scalar::Scalar;
let iv = Scalar::Interval { months: 0, days: 0, micros: 5_400_000_000 };
assert_eq!(iv.render(), "01:30:00");

Implementations§

Source§

impl Scalar

Source

pub fn is_null(&self) -> bool

Whether this is SQL NULL.

§Examples
use kevy_scalar::Scalar;
assert!(Scalar::Null.is_null());
assert!(!Scalar::Int(0).is_null(), "zero is a value, not a NULL");
assert!(!Scalar::Text(String::new()).is_null(), "so is the empty string");
Source

pub fn render(&self) -> String

PG’s text output form for this value. Null renders as the empty string here — a caller that needs a NULL marker (the sqllogictest runner does) checks Scalar::is_null first.

§Examples
use kevy_scalar::Scalar;
assert_eq!(Scalar::Int(42).render(), "42");
assert_eq!(Scalar::Text("ada".into()).render(), "ada");
assert_eq!(Scalar::Bool(true).render(), "t", "PG's boolean output");

Trait Implementations§

Source§

impl Clone for Scalar

Source§

fn clone(&self) -> Scalar

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 Scalar

Source§

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

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

impl PartialEq for Scalar

Source§

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

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.