toasty 0.7.0

An async ORM for Rust supporting SQL and NoSQL databases
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use super::{IntoExpr, List, Numeric, Path};
use std::marker::PhantomData;
use toasty_core::stmt;

/// Apply a field mutation to an update statement's [`Assignments`] map.
///
/// Every update builder setter accepts `impl Assign<T>`. All types that
/// implement [`IntoExpr<T>`] also implement `Assign<T>` with set semantics,
/// so update setters accept the same types as create setters.
///
/// For has-many fields, arrays and [`Vec`]s implement
/// `Assign<List<T>>` with set (replace) semantics. Use [`insert`],
/// [`remove`], or [`apply`] for incremental mutations.
///
/// [`Assignments`]: toasty_core::stmt::Assignments
pub trait Assign<T> {
    /// Convert into an [`Assignment<T>`] value.
    fn into_assignment(self) -> Assignment<T>;

    /// Record one or more assignments into the given [`Assignments`] map at
    /// the specified projection.
    fn assign(self, assignments: &mut stmt::Assignments, projection: stmt::Projection)
    where
        Self: Sized,
    {
        self.into_assignment().kind.apply(assignments, projection);
    }
}

/// A typed assignment produced by the [`insert`], [`remove`], [`set`], and
/// [`patch`] combinators.
///
/// `Assignment<T>` implements `Assign<T>`, so it can be passed directly
/// to any update builder setter that accepts `impl Assign<T>`.
pub struct Assignment<T> {
    kind: AssignmentKind,
    _p: PhantomData<T>,
}

enum AssignmentKind {
    Set(stmt::Expr),
    Insert(stmt::Expr),
    Remove(stmt::Expr),
    Append(stmt::Expr),
    Pop,
    RemoveAt(stmt::Expr),
    Add(stmt::Expr),
    Subtract(stmt::Expr),
    Patch {
        path_projection: stmt::Projection,
        inner: Box<AssignmentKind>,
    },
    Apply(Vec<AssignmentKind>),
}

impl AssignmentKind {
    fn apply(self, assignments: &mut stmt::Assignments, projection: stmt::Projection) {
        match self {
            AssignmentKind::Set(expr) => assignments.set(projection, expr),
            AssignmentKind::Insert(expr) => assignments.insert(projection, expr),
            AssignmentKind::Remove(expr) => assignments.remove(projection, expr),
            AssignmentKind::Append(expr) => assignments.append(projection, expr),
            AssignmentKind::Pop => assignments.pop(projection),
            AssignmentKind::RemoveAt(expr) => assignments.remove_at(projection, expr),
            AssignmentKind::Add(expr) => assignments.add(projection, expr),
            AssignmentKind::Subtract(expr) => assignments.subtract(projection, expr),
            AssignmentKind::Patch {
                path_projection,
                inner,
            } => {
                let mut projection = projection;
                for &step in path_projection.as_slice() {
                    projection.push(step);
                }
                inner.apply(assignments, projection);
            }
            AssignmentKind::Apply(ops) => {
                for op in ops {
                    op.apply(assignments, projection.clone());
                }
            }
        }
    }
}

// Assignment<T> implements Assign<T>
impl<T> Assign<T> for Assignment<T> {
    fn into_assignment(self) -> Assignment<T> {
        self
    }
}

/// Helper macro: generates `impl Assign<$target> for $source` with set
/// semantics by delegating to `IntoExpr`. Used alongside every `IntoExpr`
/// impl to keep the two traits in sync.
macro_rules! impl_assign_via_expr {
    // Simple: impl Assign<T> for S
    ($source:ty => $target:ty) => {
        impl super::assignment::Assign<$target> for $source {
            fn into_assignment(self) -> super::assignment::Assignment<$target> {
                $crate::stmt::set(
                    super::IntoExpr::<$target>::into_expr(self),
                )
            }
        }
    };
    // Generic: impl<generics> Assign<Target> for Source where bounds
    // Uses { } instead of [ ] to avoid parsing ambiguity with array types.
    ({ $($gen:tt)* } $source:ty => $target:ty) => {
        impl<$($gen)*> super::assignment::Assign<$target> for $source {
            fn into_assignment(self) -> super::assignment::Assignment<$target> {
                $crate::stmt::set(
                    super::IntoExpr::<$target>::into_expr(self),
                )
            }
        }
    };
}

// Make the macro available to into_expr.rs (sibling module)
pub(super) use impl_assign_via_expr;

/// Insert a value into a collection field.
///
/// Takes an expression of `T` (a single item) and produces an assignment for
/// `List<T>` (the collection). The returned [`Assignment`] can be passed to any
/// update builder setter that accepts `impl Assign<List<T>>`.
///
/// [`Assignments`]: toasty_core::stmt::Assignments
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .todos(stmt::insert(Todo::create().title("Buy groceries")))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn insert<T>(expr: impl IntoExpr<T>) -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::Insert(expr.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Remove a value from a collection field.
///
/// Takes an expression of `T` (the item to remove) and produces an assignment
/// for `List<T>` (the collection).
///
/// What "remove" means depends on the field kind:
/// - **`Vec<scalar>` field**: every element equal to the value is removed,
///   atomically against the existing column value. Backends that advertise
///   [`Capability::vec_remove`](toasty_core::driver::Capability::vec_remove)
///   support this — currently PostgreSQL only; other backends return an
///   error.
/// - **Has-many relation**: the related record is dissociated. With an
///   optional foreign key the FK is set to `NULL`; with a required foreign
///   key the related record is deleted.
///
/// # Examples
///
/// ```ignore
/// // Vec<String> field
/// user.update()
///     .tags(stmt::remove("admin"))
///     .exec(&mut db)
///     .await?;
///
/// // Has-many relation
/// user.update()
///     .todos(stmt::remove(&todo_a))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn remove<T>(expr: impl IntoExpr<T>) -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::Remove(expr.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Replace a field's value entirely.
///
/// For collection fields, `set` replaces the entire collection: all current
/// members are disassociated (following the same optional/required foreign key
/// rules as [`remove`]), then the new set is associated.
///
/// Pass an empty slice to clear the collection:
///
/// ```ignore
/// user.update()
///     .todos(stmt::set::<List<Todo>>([]))
///     .exec(&mut db)
///     .await?;
/// ```
///
/// For scalar fields, `set` is equivalent to passing a plain value (the
/// setter already defaults to set semantics).
///
/// # Examples
///
/// ```ignore
/// // Replace all todos
/// user.update()
///     .todos(stmt::set([
///         Todo::create().title("Only todo"),
///     ]))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn set<T>(expr: impl IntoExpr<T>) -> Assignment<T> {
    Assignment {
        kind: AssignmentKind::Set(expr.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Append one element to an ordered collection field (e.g. `Vec<scalar>`).
///
/// Takes an expression of `T` (the element to append) and produces an
/// assignment for `List<T>` (the collection). The append is atomic
/// against the existing column value on every supported backend.
///
/// After `.exec()`, the instance's field reflects the post-update value
/// (old contents followed by the appended element).
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .tags(stmt::push("admin"))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn push<T>(expr: impl IntoExpr<T>) -> Assignment<List<T>> {
    let element = expr.into_expr().untyped;
    Assignment {
        kind: AssignmentKind::Append(stmt::Expr::list([element])),
        _p: PhantomData,
    }
}

/// Append every element of a list to an ordered collection field.
///
/// Takes a list-shaped expression (anything that converts to `List<T>`
/// — `Vec<T>`, `[T; N]`, `&[T]`, …) and produces an assignment for
/// `List<T>`. Elements are appended in order and the operation is
/// atomic against the existing column value, same as [`push`].
///
/// After `.exec()`, the instance's field reflects the post-update value.
/// `stmt::extend(iter)` of an empty iterator is a no-op.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .tags(stmt::extend(["admin", "verified"]))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn extend<T>(items: impl IntoExpr<List<T>>) -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::Append(items.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Remove every element from an ordered collection field.
///
/// Produces an assignment for `List<T>` that replaces the column with an
/// empty list. Equivalent to passing an empty Vec to the field setter,
/// just more explicit at the call site.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .tags(stmt::clear())
///     .exec(&mut db)
///     .await?;
/// ```
pub fn clear<T>() -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::Set(stmt::Expr::list(Vec::<stmt::Expr>::new())),
        _p: PhantomData,
    }
}

/// Drop the last element of an ordered collection field.
///
/// Produces an assignment for `List<T>` that removes the trailing element
/// of the existing column value. The popped element is discarded — the
/// assignment API does not return values. Empty-collection is a no-op
/// rather than an error; for failure-on-empty semantics, filter the
/// collection first.
///
/// Atomic against the existing column value. Backends that advertise
/// [`Capability::vec_pop`](toasty_core::driver::Capability::vec_pop)
/// support this — currently PostgreSQL only; other backends return an
/// error.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .tags(stmt::pop())
///     .exec(&mut db)
///     .await?;
/// ```
pub fn pop<T>() -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::Pop,
        _p: PhantomData,
    }
}

/// Drop the element at the given index from an ordered collection field.
///
/// Takes a `usize`-typed index and produces an assignment for `List<T>`
/// that removes the element at that position. Out-of-bounds indices are
/// a no-op rather than an error — per-row failure semantics on a bulk
/// update are rarely useful.
///
/// Atomic against the existing column value. Backends that advertise
/// [`Capability::vec_remove_at`](toasty_core::driver::Capability::vec_remove_at)
/// support this — currently PostgreSQL only; other backends return an
/// error.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .tags(stmt::remove_at(0))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn remove_at<T>(idx: impl IntoExpr<usize>) -> Assignment<List<T>> {
    Assignment {
        kind: AssignmentKind::RemoveAt(idx.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Partially update a sub-field of an embedded type.
///
/// Takes a [`Path<T, U>`] (identifying which sub-field to update) and a
/// value (`impl Assign<U>` — either a plain value or a nested
/// [`Assignment<U>`] for deeper patching). Returns an [`Assignment<T>`]
/// that can be passed to the parent field's setter.
///
/// # Examples
///
/// ```ignore
/// // Update a single sub-field
/// user.update()
///     .critter(stmt::patch(Creature::fields().human().profession(), "doctor"))
///     .exec(&mut db)
///     .await?;
///
/// // Nested patching
/// user.update()
///     .kind(stmt::patch(
///         Kind::variants().admin().perm(),
///         stmt::patch(Permission::fields().everything(), true),
///     ))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn patch<T, U>(path: Path<T, U>, value: impl Assign<U>) -> Assignment<T> {
    let inner = value.into_assignment();

    Assignment {
        kind: AssignmentKind::Patch {
            path_projection: path.untyped.projection,
            inner: Box::new(inner.kind),
        },
        _p: PhantomData,
    }
}

/// Apply multiple operations to a single field.
///
/// Takes an array or [`Vec`] of [`Assignment<T>`] and applies each in order.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .todos(stmt::apply([
///         stmt::insert(Todo::create().title("Buy groceries")),
///         stmt::insert(Todo::create().title("Walk the dog")),
///         stmt::remove(&old_todo),
///     ]))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn apply<T>(ops: impl IntoIterator<Item = Assignment<T>>) -> Assignment<T> {
    let ops: Vec<AssignmentKind> = ops.into_iter().map(|a| a.kind).collect();
    Assignment {
        kind: AssignmentKind::Apply(ops),
        _p: PhantomData,
    }
}

/// Add a value to a numeric field (`col = col + value`).
///
/// The [`Numeric`] bound restricts `T` to types Toasty knows how to do
/// database arithmetic on, so misuse on a non-numeric column (e.g.
/// `String`) is a compile error rather than a runtime database error.
///
/// The update is atomic against the existing column value on every backend.
/// Use this when you want a relative update — e.g. crediting a balance —
/// without a read-modify-write round trip from the client.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .balance(stmt::add(10))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn add<T: Numeric>(value: impl IntoExpr<T>) -> Assignment<T> {
    Assignment {
        kind: AssignmentKind::Add(value.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Subtract a value from a numeric field (`col = col - value`).
///
/// Mirror of [`add`]. See its docs for the [`Numeric`] bound. Atomic
/// against the existing column value on every backend.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .balance(stmt::subtract(5))
///     .exec(&mut db)
///     .await?;
/// ```
pub fn subtract<T: Numeric>(value: impl IntoExpr<T>) -> Assignment<T> {
    Assignment {
        kind: AssignmentKind::Subtract(value.into_expr().untyped),
        _p: PhantomData,
    }
}

/// Increment a numeric field by one.
///
/// The [`Numeric`] bound encodes the `1` literal in a value variant
/// matching the field type, so `stmt::increment()` works on every
/// supported numeric column (`i8`–`i64`, `u8`–`u64`, `f32`, `f64`) and
/// on user newtypes that implement [`Numeric`].
///
/// Atomic against the existing column value on every backend, same as
/// [`add`].
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .login_count(stmt::increment())
///     .exec(&mut db)
///     .await?;
/// ```
pub fn increment<T: Numeric>() -> Assignment<T> {
    Assignment {
        kind: AssignmentKind::Add(stmt::Expr::Value(T::one())),
        _p: PhantomData,
    }
}

/// Decrement a numeric field by one.
///
/// Mirror of [`increment`]. See its docs for the [`Numeric`] bound and
/// the set of supported field types.
///
/// # Examples
///
/// ```ignore
/// user.update()
///     .lives_left(stmt::decrement())
///     .exec(&mut db)
///     .await?;
/// ```
pub fn decrement<T: Numeric>() -> Assignment<T> {
    Assignment {
        kind: AssignmentKind::Subtract(stmt::Expr::Value(T::one())),
        _p: PhantomData,
    }
}