Struct EmbedSelection 

pub struct EmbedSelection {
    pub relationship: String,
    pub output_key: String,
    pub fields: Vec<String>,
    pub filter: Option<Value>,
    pub limit: Option<u32>,
    pub embeds: Vec<EmbedSelection>,
    pub counts: Vec<CountSelection>,
}

A relationship to embed into each row of the level above it.

Fields

relationship: String

The relationship’s name on the parent type.

output_key: String

The key the embedded value is written under — the relationship’s name, or the client’s rename.

fields: Vec<String>

The target type’s fields to return, in the order they were asked for.

filter: Option<Value>

The client’s filter on the related rows, in the {field: {op: value}} shape a where argument takes. Composed with the target’s own security predicate the way a filter on a flat read of the target is, so it can only narrow.

limit: Option<u32>

The page each parent row gets of related rows. Capped by max_page_size, as any read’s page is.

embeds: Vec<EmbedSelection>

Relationships to embed into each related row.

counts: Vec<CountSelection>

Relationships to count for each related row.

Trait Implementations

impl Clone for EmbedSelection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedSelection

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

Formats the value using the given formatter.

impl Default for EmbedSelection

fn default() -> Self

Returns the “default value” for a type.

impl Eq for EmbedSelection

impl PartialEq for EmbedSelection

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EmbedSelection