Skip to main content

Related

Struct Related 

Source
pub struct Related<C> { /* private fields */ }
Expand description

Rows loaded for a relationship, grouped by the near side’s key.

Returned by every relation’s load. Look a parent’s related rows up by handing it the parent — the container knows which column to read.

Implementations§

Source§

impl<C> Related<C>

Source

pub fn empty(near_key: impl Into<String>) -> Self

An empty result — what loading no parents gives you.

Source

pub fn of<N: Model>(&self, near: &N) -> &[C]

Every related row for near, in the order the query returned them.

Source

pub fn one<N: Model>(&self, near: &N) -> Option<&C>

The first related row for near — what a has_one or belongs_to wants.

Source

pub fn count_of<N: Model>(&self, near: &N) -> usize

How many related rows near has among those loaded.

Not the same as Relation::count, which asks the database and is not limited by any limit on the relation.

Source

pub fn is_empty(&self) -> bool

Whether anything was loaded at all.

Source

pub fn len(&self) -> usize

How many rows were loaded, across every parent.

Source

pub fn near_key(&self) -> &str

The column the map is keyed by.

Source

pub fn zip<N: Model>(self, near: Vec<N>) -> Vec<(N, Vec<C>)>

Pair each of near with its related rows, consuming both.

For handing a controller something to serialise: a Vec<(Post, Vec<Comment>)> rather than two collections and a lookup.

Trait Implementations§

Source§

impl<C: Clone> Clone for Related<C>

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<C: Debug> Debug for Related<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Related<C>

§

impl<C> RefUnwindSafe for Related<C>

§

impl<C> Send for Related<C>

§

impl<C> Sync for Related<C>

§

impl<C> Unpin for Related<C>

§

impl<C> UnsafeUnpin for Related<C>

§

impl<C> UnwindSafe for Related<C>

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> Event for T
where T: Send + Sync + 'static,

Source§

fn event_name() -> &'static str
where Self: Sized,

A human-readable name, used by wildcard listeners and log output. Always the Rust type path; see the trait docs.
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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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