Struct TryGroupedByError

#[non_exhaustive]
pub struct TryGroupedByError<Child> {
    pub grouped: Vec<Vec<Child>>,
    pub ungrouped: Vec<Child>,
}

A type of error which can be returned when attempting to group a list of records.

If a child record has a nullable foreign key, or is being grouped using a different relationship to the one that was used to query it, it may not be possible to find a parent record it should be grouped by.

When encountering these missing relationships, it may still be possible to group remaining records, but would affect the contents of the returned values. By extracting the contents of this struct, it is still possible to use these resulting groups, as well as any records that could not be grouped.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

grouped: Vec<Vec<Child>>

The collection of records which were successfully indexed against a parent record.

ungrouped: Vec<Child>

The collection of records that could not be indexed against a parent record.

Implementations

impl<Child> TryGroupedByError<Child>

pub fn new(grouped: Vec<Vec<Child>>, ungrouped: Vec<Child>) -> Self

Creates a TryGroupedByError.

This is generally used by methods like GroupedBy::try_grouped_by.

Trait Implementations

impl<Child: Clone> Clone for TryGroupedByError<Child>

fn clone(&self) -> TryGroupedByError<Child>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Child: Debug> Debug for TryGroupedByError<Child>

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

Formats the value using the given formatter.

impl<Child: Hash> Hash for TryGroupedByError<Child>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Child: Ord> Ord for TryGroupedByError<Child>

fn cmp(&self, other: &TryGroupedByError<Child>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Child: PartialEq> PartialEq for TryGroupedByError<Child>

fn eq(&self, other: &TryGroupedByError<Child>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Child: PartialOrd> PartialOrd for TryGroupedByError<Child>

fn partial_cmp(&self, other: &TryGroupedByError<Child>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Child: Eq> Eq for TryGroupedByError<Child>

impl<Child> StructuralPartialEq for TryGroupedByError<Child>