pub struct RelationInclude<M, Rel, RelPK>where
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.
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>
impl<M, Rel, RelPK> Clone for RelationInclude<M, Rel, RelPK>
Source§fn clone(&self) -> RelationInclude<M, Rel, RelPK>
fn clone(&self) -> RelationInclude<M, Rel, RelPK>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<M, Rel, RelPK> Debug for RelationInclude<M, Rel, RelPK>
impl<M, Rel, RelPK> Debug for RelationInclude<M, Rel, RelPK>
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> 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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);