Skip to main content

RelationInclude

Struct RelationInclude 

Source
pub struct RelationInclude<M: 'static, Rel: 'static, RelPK: 'static> {
    pub parent_fk_extract: fn(&M) -> Option<RelPK>,
    pub related_descriptor: &'static ModelDescriptor<Rel, RelPK>,
}
Expand description

Typed handle for an .include(...) call on a query builder. Carries everything the runtime needs to issue the side-load query for a to-one relation: a function pointer that extracts the FK value from a parent row, and a static descriptor of the related model.

Built by the macro-emitted <model_module>::<relation_name>() accessor — see the .include(...) builder method on FindMany.

Scope (v1): to-one relations only, where the related target column is the related model’s primary key. Non-PK references and to-many relations are out of scope for this release; the macro silently omits accessors for non-PK references, and to-many relations stay on the existing list-side query path.

Fields§

§parent_fk_extract: fn(&M) -> Option<RelPK>

Extracts the FK value from a parent row. None ⇒ the parent’s FK column is null, so there’s no related row to load. Function pointers (not closures) by design: keep the type cheap to copy and ensure call sites can’t smuggle in captures that outlive the descriptor’s 'static.

§related_descriptor: &'static ModelDescriptor<Rel, RelPK>

The related model’s descriptor. The runtime uses this to drive the side-load query (SELECT projection FROM related WHERE related.pk IN (...)) so the related-side read policy still applies.

Trait Implementations§

Source§

impl<M, Rel, RelPK> Clone for RelationInclude<M, Rel, RelPK>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<M, Rel, RelPK> Debug for RelationInclude<M, Rel, RelPK>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<M, Rel, RelPK> Copy for RelationInclude<M, Rel, RelPK>

Auto Trait Implementations§

§

impl<M, Rel, RelPK> Freeze for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> RefUnwindSafe for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> Send for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> Sync for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> Unpin for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> UnsafeUnpin for RelationInclude<M, Rel, RelPK>

§

impl<M, Rel, RelPK> UnwindSafe for RelationInclude<M, Rel, RelPK>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.