Struct IncludeSpec 

pub struct IncludeSpec {
    pub relation_name: String,
    pub filter: Option<Filter>,
    pub order_by: Option<OrderBy>,
    pub pagination: Option<Pagination>,
    pub nested: HashMap<String, IncludeSpec>,
    pub include_count: bool,
}

Specification for including a relation in a query.

Fields

relation_name: String

Name of the relation to include.

filter: Option<Filter>

Filter to apply to the related records.

order_by: Option<OrderBy>

Ordering for the related records.

pagination: Option<Pagination>

Pagination for the related records.

nested: HashMap<String, IncludeSpec>

Nested includes.

include_count: bool

Whether to include the count of related records.

Implementations

impl IncludeSpec

pub fn new(relation_name: impl Into<String>) -> Self

Create a new include spec for a relation.

pub fn where(self, filter: impl Into<Filter>) -> Self

Add a filter to the included relation.

pub fn order_by(self, order: impl Into<OrderBy>) -> Self

Set ordering for the included relation.

pub fn skip(self, n: u64) -> Self

Skip records in the included relation.

pub fn take(self, n: u64) -> Self

Take a limited number of records from the included relation.

pub fn include(self, nested: IncludeSpec) -> Self

Include a nested relation.

pub fn with_count(self) -> Self

Include the count of related records.

pub fn has_nested(&self) -> bool

Check if there are nested includes.

pub fn nested_specs(&self) -> impl Iterator<Item = &IncludeSpec>

Get all nested include specs.

Trait Implementations

impl Clone for IncludeSpec

fn clone(&self) -> IncludeSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeSpec

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

Formats the value using the given formatter.

impl From<IncludeSpec> for Include

fn from(spec: IncludeSpec) -> Self

Converts to this type from the input type.

impl FromIterator<IncludeSpec> for Include

fn from_iter<T: IntoIterator<Item = IncludeSpec>>(iter: T) -> Self

Creates a value from an iterator.