Struct RelationInclude 

pub struct RelationInclude {
    pub path: String,
    pub fields: Vec<String>,
    pub filter: Option<Filter>,
    pub order_by: Vec<OrderSpec>,
    pub pagination: Option<Pagination>,
}

An included relation in a graph query.

The path field uses dot-notation for nested relations:

• “posts” - include posts from root entity
• “posts.comments” - include comments from posts
• “posts.author” - include author from posts

Fields

path: String

Dot-separated path to this relation (e.g., “posts.comments”).

fields: Vec<String>

Fields to select from the related entity.

filter: Option<Filter>

Optional filter for the related entities.

order_by: Vec<OrderSpec>

Ordering for the related entities.

pagination: Option<Pagination>

Pagination for the related entities.

Implementations

impl RelationInclude

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

Create a new include for a relation.

pub fn with_fields(self, fields: Vec<String>) -> Self

Set the fields to select.

pub fn with_filter(self, filter: Filter) -> Self

Set a filter for this include.

pub fn with_order(self, order: OrderSpec) -> Self

Add ordering for this include.

pub fn with_pagination(self, pagination: Pagination) -> Self

Set pagination for this include.

pub fn relation_name(&self) -> &str

Get the relation name (last segment of the path).

pub fn parent_path(&self) -> Option<&str>

Get the parent path (all segments except the last).

pub fn is_top_level(&self) -> bool

Check if this is a top-level include (no dots in path).

pub fn depth(&self) -> usize

Get the depth of this include (number of dots + 1).

Trait Implementations

impl Archive for RelationInclude

where String: Archive, Vec<String>: Archive, Option<Filter>: Archive, Vec<OrderSpec>: Archive, Option<Pagination>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedRelationInclude

The archived representation of this type.

type Resolver = RelationIncludeResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for RelationInclude

fn clone(&self) -> RelationInclude

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationInclude

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelationInclude

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<RelationInclude, __D> for Archived<RelationInclude>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Vec<String>: Archive, <Vec<String> as Archive>::Archived: Deserialize<Vec<String>, __D>, Option<Filter>: Archive, <Option<Filter> as Archive>::Archived: Deserialize<Option<Filter>, __D>, Vec<OrderSpec>: Archive, <Vec<OrderSpec> as Archive>::Archived: Deserialize<Vec<OrderSpec>, __D>, Option<Pagination>: Archive, <Option<Pagination> as Archive>::Archived: Deserialize<Option<Pagination>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<RelationInclude, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl PartialEq for RelationInclude

fn eq(&self, other: &RelationInclude) -> 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<__S: Fallible + ?Sized> Serialize<__S> for RelationInclude

where String: Serialize<__S>, Vec<String>: Serialize<__S>, Option<Filter>: Serialize<__S>, Vec<OrderSpec>: Serialize<__S>, Option<Pagination>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for RelationInclude

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RelationInclude