Struct Sql 

pub struct Sql<const N: usize> { /* private fields */ }

The text of a statement rendered in a const: up to N bytes.

postgres, mysql and sqlite fill one from a TableSpec. N is the caller’s choice; a text longer than N is refused with a panic that names N, the table and the length the text needs, so in a const it is a build error that says what to raise N to.

Examples

use ruststream_sqlx_dialect::insert::{self, Sql};
use ruststream_sqlx_dialect::{Column, Form, TableSpec};

const MAIL: TableSpec<'static> = TableSpec::new(
    "mail",
    Column::new("id").generated(),
    Form::Lease(Column::new("locked_until")),
)
.data(&[Column::new("recipient")]);

const INSERT: Sql<96> = insert::sqlite(&MAIL);

// A constant's text lives as long as the program, as a driver's prepared statement needs.
let sql: &'static str = INSERT.as_str();
assert_eq!(sql, "INSERT INTO `mail` (`locked_until`, `recipient`) VALUES (?, ?)");

A capacity the text outgrows does not build:

use ruststream_sqlx_dialect::insert::{self, Sql};
use ruststream_sqlx_dialect::{Column, Form, TableSpec};

const MAIL: TableSpec<'static> = TableSpec::new("mail", Column::new("id"), Form::RowLock)
    .data(&[Column::new("recipient")]);

// The insert into `mail` takes 52 bytes, more than `Sql<16>` holds.
pub const INSERT: Sql<16> = insert::sqlite(&MAIL);

Implementations

impl<const N: usize> Sql<N>

pub const fn as_str(&self) -> &str

The text.

Examples

use ruststream_sqlx_dialect::insert::{self, Sql};
use ruststream_sqlx_dialect::{Column, Form, TableSpec};

const JOBS: TableSpec<'static> =
    TableSpec::new("jobs", Column::new("id"), Form::RowLock).payload(Column::new("payload"));
const INSERT: Sql<64> = insert::mysql(&JOBS);

assert_eq!(INSERT.as_str(), "INSERT INTO `jobs` (`id`, `payload`) VALUES (?, ?)");

Trait Implementations

impl<const N: usize> AsRef<str> for Sql<N>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: usize> Clone for Sql<N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Copy for Sql<N>

impl<const N: usize> Debug for Sql<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for Sql<N>

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

Formats the value using the given formatter.

impl<const N: usize> Eq for Sql<N>

impl<const N: usize> Hash for Sql<N>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize> PartialEq for Sql<N>

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> StructuralPartialEq for Sql<N>