Skip to main content

ProjectionField

Struct ProjectionField 

Source
pub struct ProjectionField {
    pub name: String,
    pub source: String,
    pub kind: FieldKind,
    pub sub_fields: Option<Vec<ProjectionField>>,
}
Expand description

A field in a SQL projection with type information.

Used by typed projection generators to choose the correct JSONB extraction operator based on FieldKind: -> (preserves JSONB) for composites and native scalars, ->> (text) for text scalars (String, ID).

When sub_fields is populated on a composite field, generate_typed_projection_sql will recurse and emit a nested jsonb_build_object(...) instead of returning the full composite blob. Leave sub_fields as None to get the existing data->'field' behaviour (full blob, no sub-selection).

Fields§

§name: String

Output (response) key — the GraphQL alias if present, otherwise the field name. Used verbatim as the key in the generated jsonb_build_object.

§source: String

Source GraphQL field name (camelCase) used to derive the JSONB column via to_snake_case. Equals name for unaliased fields, but differs when the field is aliased: myName: fullName yields name = "myName", source = "fullName", so the projection reads data->>'full_name' while emitting it under the myName key (#418).

§kind: FieldKind

Semantic kind of the field, controlling the JSONB extraction operator.

§sub_fields: Option<Vec<ProjectionField>>

Sub-fields to project for composite (Object) types.

When Some and non-empty, the generator recurses and produces a nested jsonb_build_object instead of returning the entire composite blob. Set to None (or Some([])) to fall back to data->'field'. List fields should always use None — sub-projection inside aggregated JSONB arrays is out of scope for this first iteration.

Implementations§

Source§

impl ProjectionField

Source

pub fn scalar(name: impl Into<String>) -> Self

Create a text scalar projection field (uses ->> text extraction).

Use for String and ID fields only. Other scalars (Int, Float, Boolean, DateTime, etc.) should use Self::native.

Source

pub fn native(name: impl Into<String>) -> Self

Create a native JSON scalar projection field (uses -> to preserve type).

Use for Int, Float, Boolean, DateTime, Date, Time, Decimal, Vector, and other non-text scalars. ->> would coerce these to strings inside jsonb_build_object, losing type information.

Source

pub fn composite(name: impl Into<String>) -> Self

Create a composite (object/list) projection field (uses -> JSONB extraction).

Source

pub fn composite_with_sub_fields( name: impl Into<String>, sub_fields: Vec<Self>, ) -> Self

Create a composite projection field with known sub-fields.

The generator will recurse into sub_fields and emit a nested jsonb_build_object(...) rather than returning the full composite blob.

Source

pub const fn is_composite(&self) -> bool

Whether this field is a composite type (Object or List).

Trait Implementations§

Source§

impl Clone for ProjectionField

Source§

fn clone(&self) -> ProjectionField

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProjectionField

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ProjectionField

Source§

impl From<String> for ProjectionField

Source§

fn from(name: String) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ProjectionField

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for ProjectionField

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more