Skip to main content

FactoryBuilder

Struct FactoryBuilder 

Source
pub struct FactoryBuilder<T: Factory> { /* private fields */ }
Expand description

Builder for creating model instances with customizations

Implementations§

Source§

impl<T: Factory> FactoryBuilder<T>

Source

pub fn new() -> Self

Create a new factory builder

Source

pub fn count(self, count: usize) -> Self

Set the number of models to create

Source

pub fn state<F>(self, f: F) -> Self
where F: Fn(&mut T) + Send + Sync + 'static,

Apply a state transformation to the model

Source

pub fn set<V, F>(self, value: V, setter: F) -> Self
where V: Clone + Send + Sync + 'static, F: Fn(&mut T, V) + Send + Sync + 'static,

Set a field value using a setter function

This is useful for setting foreign keys when creating associated models. The value is cloned for each model when creating multiple instances.

§Example
// Create a user first, then create posts belonging to that user
let user = User::factory().create().await?;

let post = Post::factory()
    .set(user.id, |p, user_id| p.user_id = user_id)
    .create()
    .await?;

// Create multiple posts for the same user
let posts = Post::factory()
    .count(5)
    .set(user.id, |p, user_id| p.user_id = user_id)
    .create_many()
    .await?;
Source

pub fn trait_(self, name: &'static str) -> Self

Apply a named trait (state) defined in the Factory

§Example
let admin = User::factory()
    .trait_("admin")
    .trait_("verified")
    .create()
    .await?;
Source

pub fn after_make<F>(self, f: F) -> Self
where F: Fn(&T) + Send + Sync + 'static,

Add a callback to run after making (but before persisting)

§Example
let user = User::factory()
    .after_make(|u| println!("Made user: {}", u.name))
    .create()
    .await?;
Source

pub fn after_create<F, Fut>(self, f: F) -> Self
where F: Fn(T) -> Fut + Send + 'static, Fut: Future<Output = Result<(), FrameworkError>> + Send + 'static, T: Clone,

Add an async callback to run after creating (persisting to database)

§Example
let user = User::factory()
    .after_create(|u| async move {
        // Create related records
        Profile::factory()
            .state(|p| p.user_id = u.id)
            .create()
            .await?;
        Ok(())
    })
    .create()
    .await?;
Source

pub fn make(self) -> T

Build a single model instance without persisting

Source

pub fn make_many(self) -> Vec<T>

Build multiple model instances without persisting

Source§

impl<T: DatabaseFactory> FactoryBuilder<T>

Source

pub async fn create(self) -> Result<T, FrameworkError>

Create a single model instance and persist to database

§Example
let user = User::factory()
    .state(|u| u.name = "John".into())
    .create()
    .await?;
Source

pub async fn create_many(self) -> Result<Vec<T>, FrameworkError>

Create multiple model instances and persist to database

§Example
let users = User::factory()
    .count(5)
    .create_many()
    .await?;

Trait Implementations§

Source§

impl<T: Factory> Default for FactoryBuilder<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for FactoryBuilder<T>

§

impl<T> !RefUnwindSafe for FactoryBuilder<T>

§

impl<T> Send for FactoryBuilder<T>

§

impl<T> !Sync for FactoryBuilder<T>

§

impl<T> Unpin for FactoryBuilder<T>

§

impl<T> UnsafeUnpin for FactoryBuilder<T>

§

impl<T> !UnwindSafe for FactoryBuilder<T>

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> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more