pub struct Builder<F: Bsql>(/* private fields */);Expand description
Builder for a SQL fragment with bound parameters
Usually created with bsql!.
Implementations§
Source§impl Builder<EmptyFragment>
impl Builder<EmptyFragment>
pub const fn new_untracked() -> Self
Sourcepub const fn start(loc: &'static CodeLocation) -> Builder<impl Bsql>
pub const fn start(loc: &'static CodeLocation) -> Builder<impl Bsql>
Start building a Bsql in the normal way
loc is ignored in release builds.
Sourcepub const fn with_location(loc: &'static CodeLocation) -> Builder<impl Bsql>
pub const fn with_location(loc: &'static CodeLocation) -> Builder<impl Bsql>
Make a Bsql that definitely has a code location
Source§impl<F: Bsql> Builder<F>
impl<F: Bsql> Builder<F>
Sourcepub const fn text<'o, T>(self, text: T) -> Builder<impl Bsql + 'o>
pub const fn text<'o, T>(self, text: T) -> Builder<impl Bsql + 'o>
Appends a fragment of SQL text.
The SQL text must not contain any bind parameter placeholders, since there isn’t any way to pass the corresponding values.
Sourcepub const fn value<'o, V>(self, value: V) -> Builder<impl Bsql + 'o>
pub const fn value<'o, V>(self, value: V) -> Builder<impl Bsql + 'o>
Appends a single bind value.
SQL text: ?
Sourcepub const fn fragment<'o, F2>(self, fragment: F2) -> Builder<impl Bsql + 'o>where
F: 'o,
F2: Bsql + 'o,
pub const fn fragment<'o, F2>(self, fragment: F2) -> Builder<impl Bsql + 'o>where
F: 'o,
F2: Bsql + 'o,
Appends a SQL fragment with its bound values.
Sourcepub const fn array_as_row_value<'o, T, const N: usize>(
self,
array: [T; N],
) -> Builder<impl Bsql + 'o>
pub const fn array_as_row_value<'o, T, const N: usize>( self, array: [T; N], ) -> Builder<impl Bsql + 'o>
Appends an Rust array as a SQL row value
SQL text: (?,?,...)
Sourcepub const fn insert_row<'o, R>(self, row: R) -> Builder<impl Bsql + 'o>where
F: 'o,
R: AsBsqlRow + 'o,
pub const fn insert_row<'o, R>(self, row: R) -> Builder<impl Bsql + 'o>where
F: 'o,
R: AsBsqlRow + 'o,
Appends an struct which implements AsBsqlRow as a row for insert
SQL text: (COL1,COL2,...) VALUES (?,?,...)
Skips rowid columns (marked #[deftly(bsql(rowid))]).
(Use AsBsqlRow::with_rowid to include them.)
Sourcepub const fn ref_iter_as_row_value<'o, C, I>(
self,
collection: &'o C,
) -> Builder<impl Bsql + 'o>
pub const fn ref_iter_as_row_value<'o, C, I>( self, collection: &'o C, ) -> Builder<impl Bsql + 'o>
Appends an Rust reference iterator as a SQL row value.
SQL text: (?,?,...)
Adds from an iterator yielding &impl ToSql + Sync,
Supply the iterator as a reference to what is probably a collection,
so that it yields references to the contents.
Trait Implementations§
Source§impl<F: Bsql> Bsql for Builder<F>
impl<F: Bsql> Bsql for Builder<F>
Source§fn extend_text(&self, s: &mut String)
fn extend_text(&self, s: &mut String)
s with the SQL text for this fragmentSource§fn extend_params<'v, 'p: 'v>(&'p self, p: &mut Vec<DynToSql<'v>>)
fn extend_params<'v, 'p: 'v>(&'p self, p: &mut Vec<DynToSql<'v>>)
p with the bind parameter values for this fragment Read moreSource§fn extend_locs(&self, la: &mut CodeLocationAccumulator)
fn extend_locs(&self, la: &mut CodeLocationAccumulator)
Source§fn mk_sql_text(&self) -> String
fn mk_sql_text(&self) -> String
StringAuto Trait Implementations§
impl<F> Freeze for Builder<F>where
F: Freeze,
impl<F> RefUnwindSafe for Builder<F>where
F: RefUnwindSafe,
impl<F> Send for Builder<F>where
F: Send,
impl<F> Sync for Builder<F>
impl<F> Unpin for Builder<F>where
F: Unpin,
impl<F> UnwindSafe for Builder<F>where
F: UnwindSafe,
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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);