Struct rusqlite_migration::MigrationsBuilder
source · pub struct MigrationsBuilder<'u> { /* private fields */ }
Available on crate feature
from-directory
only.Expand description
Allows to build a Vec<M<'u>>
with additional edits.
Implementations§
source§impl<'u> MigrationsBuilder<'u>
impl<'u> MigrationsBuilder<'u>
sourcepub fn from_directory(dir: &'static Dir<'static>) -> Result<Self>
pub fn from_directory(dir: &'static Dir<'static>) -> Result<Self>
Creates a set of migrations from a given directory by scanning subdirectories with a specified name pattern. The migrations are loaded and stored in the binary.
See the crate::Migrations::from_directory
method for additional information regarding the directory structure.
§Example
use rusqlite_migration::{Migrations, MigrationsBuilder};
use include_dir::{Dir, include_dir};
static MIGRATION_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/../examples/from-directory/migrations");
let migrations: Migrations = MigrationsBuilder::from_directory(&MIGRATION_DIR).unwrap().finalize();
§Errors
Returns crate::Error::FileLoad
in case the subdirectory names are incorrect,
or don’t contain at least a valid up.sql
file.
sourcepub fn edit(self, id: usize, f: impl Fn(M<'_>) -> M<'_>) -> Self
pub fn edit(self, id: usize, f: impl Fn(M<'_>) -> M<'_>) -> Self
Allows to edit a migration with a given id
.
§Panics
Panics if no migration with the id
provided exists.
sourcepub fn finalize<T: FromIterator<M<'u>>>(self) -> T
pub fn finalize<T: FromIterator<M<'u>>>(self) -> T
Finalizes the builder and creates either a crate::Migrations
or a
crate::AsyncMigrations
instance.
Trait Implementations§
source§impl<'u> Debug for MigrationsBuilder<'u>
impl<'u> Debug for MigrationsBuilder<'u>
source§impl<'u> Default for MigrationsBuilder<'u>
impl<'u> Default for MigrationsBuilder<'u>
source§fn default() -> MigrationsBuilder<'u>
fn default() -> MigrationsBuilder<'u>
Returns the “default value” for a type. Read more
source§impl<'u> FromIterator<M<'u>> for MigrationsBuilder<'u>
impl<'u> FromIterator<M<'u>> for MigrationsBuilder<'u>
Auto Trait Implementations§
impl<'u> Freeze for MigrationsBuilder<'u>
impl<'u> !RefUnwindSafe for MigrationsBuilder<'u>
impl<'u> Send for MigrationsBuilder<'u>
impl<'u> Sync for MigrationsBuilder<'u>
impl<'u> Unpin for MigrationsBuilder<'u>
impl<'u> !UnwindSafe for MigrationsBuilder<'u>
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