Struct SelectSpec 

pub struct SelectSpec {
    pub model_name: String,
    pub fields: FieldSelection,
    pub relations: HashMap<String, SelectSpec>,
}

Specification for which fields to select from a model.

Fields

model_name: String

Model name this selection is for.

fields: FieldSelection

Fields to include (empty means all).

relations: HashMap<String, SelectSpec>

Relation selections.

Implementations

impl SelectSpec

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

Create a new select spec for a model.

pub fn all(model_name: impl Into<String>) -> Self

Select all fields.

pub fn only( model_name: impl Into<String>, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Select only specific fields.

pub fn except( model_name: impl Into<String>, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Exclude specific fields.

pub fn field(self, name: impl Into<String>) -> Self

Add a field to the selection.

pub fn fields(self, names: impl IntoIterator<Item = impl Into<String>>) -> Self

Add multiple fields to the selection.

pub fn relation(self, name: impl Into<String>, select: SelectSpec) -> Self

Include a relation with its selection.

pub fn is_field_selected(&self, field: &str) -> bool

Check if a field is selected.

pub fn selected_fields(&self) -> Option<&HashSet<String>>

Get the list of selected fields (if explicit).

pub fn excluded_fields(&self) -> Option<&HashSet<String>>

Get the list of excluded fields (if explicit).

pub fn is_all(&self) -> bool

Check if all fields are selected.

pub fn to_sql_columns( &self, all_columns: &[&str], table_alias: Option<&str>, ) -> String

Generate the SQL column list for this selection.

Trait Implementations

impl Clone for SelectSpec

fn clone(&self) -> SelectSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectSpec

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

Formats the value using the given formatter.