Struct WithRelated 

pub struct WithRelated<M> {
    pub inner: M,
    /* private fields */
}

A model instance with an attached relation cache (level-1, in-process).

Derefs to the inner model so field access (post.title) works directly. Relations are populated by QueryBuilder::all() when .select_related() or .prefetch_related() were chained before execution.

Example

let posts = Post::filter(&pool)
    .select_related(Post::AUTHOR_ID)
    .prefetch_related(Comment::POST_ID)
    .all()
    .await?;

for post in &posts {
    println!("{} by {}", post.title, post.related::<Author>().name);
    for comment in post.prefetched::<Comment>() {
        println!("  - {}", comment.body);
    }
}

Fields

inner: M

Implementations

impl<M> WithRelated<M>

pub fn into_inner(self) -> M

The model, dropping the loaded relations.

pub fn related<R: Any + Send + Sync + 'static>(&self) -> &R

Returns the FK-related instance loaded by select_related.

Panics

Panics with a clear message if .select_related(..) was not called for R on the query builder.

pub fn prefetched<R: Any + Send + Sync + 'static>(&self) -> &[R]

Returns the prefetched slice loaded by prefetch_related.

Panics

Panics with a clear message if .prefetch_related(..) was not called for R on the query builder.

Trait Implementations

impl<M> Deref for WithRelated<M>

type Target = M

The resulting type after dereferencing.

fn deref(&self) -> &M

Dereferences the value.

impl<M> DerefMut for WithRelated<M>

fn deref_mut(&mut self) -> &mut M

Mutably dereferences the value.