Struct query_structure::prelude::FieldSelection

pub struct FieldSelection { /* private fields */ }

A selection of fields from a model.

Implementations

impl FieldSelection

pub fn new(selections: Vec<SelectedField>) -> Self

pub fn into_inner(self) -> Vec<SelectedField>

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

Returns true if self contains (at least) all fields specified in other. false otherwise. Recurses into composite selections and ensures that composite selections are supersets as well.

pub fn selections(&self) -> impl Iterator<Item = &SelectedField> + '_

pub fn virtuals(&self) -> impl Iterator<Item = &VirtualSelection>

pub fn virtuals_owned(&self) -> Vec<VirtualSelection>

pub fn without_relations(&self) -> Self

pub fn into_virtuals_last(self) -> Self

pub fn prisma_names(&self) -> impl Iterator<Item = String> + '_

Returns all Prisma (e.g. schema model field) names of contained fields. Does not recurse into composite selections and only iterates top level fields.

pub fn db_names(&self) -> impl Iterator<Item = String> + '_

Returns all database (e.g. column or document field) names of contained fields. Does not recurse into composite selections and only iterates top level fields. Returns db aliases for virtual fields grouped into objects in the query separately, representing results of queries that do not load relations using JOINs.

pub fn db_names_grouping_virtuals(&self) -> impl Iterator<Item = String> + '_

Returns all database (e.g. column or document field) names of contained fields. Does not recurse into composite selections and only iterates top level fields. Also does not recurse into the grouped containers for virtual fields, like _count. The names returned by this method correspond to the results of queries that use JSON objects to represent joined relations and relation aggregations.

pub fn contains(&self, name: &str) -> bool

Checked if a field of prisma name name is present in this FieldSelection.

pub fn get(&self, name: &str) -> Option<&SelectedField>

pub fn as_fields(&self) -> Vec<Field>

pub fn as_scalar_fields(&self) -> Option<Vec<ScalarFieldRef>>

Checks if self only contains scalar field selections and if so, returns them all in a list. If any other selection is contained, returns None.

pub fn assimilate(&self, values: SelectionResult) -> Result<SelectionResult>

Inserts this FieldSelections selections into the given SelectionResult. Assumes caller knows that the exchange can be done, but still errors if lengths mismatch. Additionally performs a type coercion based on the source and destination field types. Resistance is futile.

pub fn matches(&self, result: &SelectionResult) -> bool

Checks if a given SelectionResult belongs to this FieldSelection.

pub fn union(selections: Vec<Self>) -> Self

Merges all given FieldSelection a set union of all. Each selection is contained exactly once, with the first occurrence of the first field in order from left to right is retained.

/!\ Important assumption: All selections are on the same model.

pub fn merge(self, other: FieldSelection) -> FieldSelection

Consumes both FieldSelections to create a new one that contains a union of both. Each selection is contained exactly once, with the first occurrence of the first field in order from left (self) to right (other) is retained. Assumes that both selections reason over the same model.

pub fn merge_in_place(&mut self, other: FieldSelection)

pub fn type_identifiers_with_arities(&self) -> Vec<(TypeIdentifier, FieldArity)>

Returns type identifiers and arities, treating all virtual fields as separate fields.

pub fn type_identifiers_with_arities_grouping_virtuals( &self ) -> Vec<(TypeIdentifier, FieldArity)>

Returns type identifiers and arities, grouping the virtual fields so that the type identifier and arity is returned for the whole object containing multiple virtual fields and not each of those fields separately. This represents the selection in joined queries that use JSON objects for relations and relation aggregations.

pub fn relations(&self) -> impl Iterator<Item = &RelationSelection>

pub fn into_projection(self) -> ModelProjection

pub fn has_virtual_fields(&self) -> bool

Trait Implementations

impl Clone for FieldSelection

fn clone(&self) -> FieldSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSelection

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

Formats the value using the given formatter.

impl Default for FieldSelection

fn default() -> FieldSelection

Returns the “default value” for a type.

impl Display for FieldSelection

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

Formats the value using the given formatter.

impl From<&FieldSelection> for ModelProjection

[Composites] todo: Temporary converter.

fn from(fs: &FieldSelection) -> Self

Converts to this type from the input type.

impl From<&FieldSelection> for SelectionResult

fn from(fs: &FieldSelection) -> Self

Converts to this type from the input type.

impl From<&SelectionResult> for FieldSelection

fn from(p: &SelectionResult) -> Self

Converts to this type from the input type.

impl From<FieldSelection> for ModelProjection

fn from(fs: FieldSelection) -> Self

Converts to this type from the input type.

impl From<Vec<Zipper<ScalarFieldId>>> for FieldSelection

fn from(fields: Vec<ScalarFieldRef>) -> Self

Converts to this type from the input type.

impl Hash for FieldSelection

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 IntoIterator for FieldSelection

type Item = SelectedField

The type of the elements being iterated over.

type IntoIter = IntoIter<<FieldSelection as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for FieldSelection

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ScalarCompare for FieldSelection

fn is_in<T>(&self, values: T) -> Filterwhere T: Into<ConditionListValue>,

Field is in a given value

fn not_in<T>(&self, values: T) -> Filterwhere T: Into<ConditionListValue>,

Field is not in a given value

fn equals<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field equals the given value.

fn not_equals<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field does not equal the given value.

fn contains<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field contains the given value.

fn not_contains<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field does not contain the given value.

fn starts_with<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field starts with the given value.

fn not_starts_with<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field does not start with the given value.

fn ends_with<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field ends with the given value.

fn not_ends_with<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field does not end with the given value.

fn less_than<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field is less than the given value.

fn less_than_or_equals<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field is less than or equals the given value.

fn greater_than<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field is greater than the given value.

fn greater_than_or_equals<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

Field is greater than or equals the given value.

fn search<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

fn not_search<T>(&self, val: T) -> Filterwhere T: Into<ConditionValue>,

fn is_set(&self, val: bool) -> Filter

impl Eq for FieldSelection

impl StructuralEq for FieldSelection

impl StructuralPartialEq for FieldSelection