Struct ColumnPreference 

pub struct ColumnPreference {
    pub key: String,
    pub user_id: String,
    pub panel: String,
    pub resource: String,
    pub columns: String,
}

Shipped record of the toggleable columns one user shows or hides in one resource’s list, on one panel.

The panel writes a row when the user applies a choice that departs from the columns’ defaults, and deletes it when the user resets to them. Register it with the app’s models when a table declares a toggleable or hidden_by_default column and auth is on.

Fields

key: String

The panel, the user and the resource, query-encoded: one row per user per list.

user_id: String

PanelUser::user_id of the user who chose; indexed so an app deleting a user can delete their rows, which the panel leaves behind.

panel: String

The prefix of the panel the list is on (e.g. /admin).

resource: String

The slug of the resource whose list it is.

columns: String

The columns the user hides or shows against their defaults, query-encoded. Text, since a few names outgrow the VARCHAR(191) MySQL gives a String.

Implementations

impl ColumnPreference

pub fn fields() -> ColumnPreferenceFields<ColumnPreference>

Returns a handle used to reference ColumnPreference’s fields when building query expressions.

pub async fn get_by_key( executor: &mut dyn Executor, key: impl IntoExpr<FieldExprTarget<String>>, ) -> Result<ColumnPreference>

Fetches the single ColumnPreference where key matches, erroring if none exists.

pub fn update_by_key( key: impl IntoExpr<FieldExprTarget<String>>, ) -> ColumnPreferenceUpdate

Returns a builder that updates the ColumnPreference where key matches.

pub async fn delete_by_key( executor: &mut dyn Executor, key: impl IntoExpr<FieldExprTarget<String>>, ) -> Result<()>

Deletes the ColumnPreference where key matches.

pub fn filter_by_key( key: impl IntoExpr<FieldExprTarget<String>>, ) -> ColumnPreferenceQuery

Returns a query selecting the ColumnPreference records where key matches.

pub async fn get_by_user_id( executor: &mut dyn Executor, user_id: impl IntoExpr<FieldExprTarget<String>>, ) -> Result<ColumnPreference>

Fetches the single ColumnPreference where user_id matches, erroring if none exists.

pub fn update_by_user_id( user_id: impl IntoExpr<FieldExprTarget<String>>, ) -> ColumnPreferenceUpdate

Returns a builder that updates the ColumnPreference where user_id matches.

pub async fn delete_by_user_id( executor: &mut dyn Executor, user_id: impl IntoExpr<FieldExprTarget<String>>, ) -> Result<()>

Deletes the ColumnPreference where user_id matches.

pub fn filter_by_user_id( user_id: impl IntoExpr<FieldExprTarget<String>>, ) -> ColumnPreferenceQuery

Returns a query selecting the ColumnPreference records where user_id matches.

pub fn create() -> ColumnPreferenceCreate

Returns a builder that inserts a new ColumnPreference record.

Typically constructed through the toasty::create! macro.

pub fn create_many() -> CreateMany<ColumnPreference>

Returns a builder that inserts multiple ColumnPreference records at once.

pub fn update(&mut self) -> ColumnPreferenceUpdate<&mut Self>

Returns a builder that updates this ColumnPreference record in place.

pub fn all() -> ColumnPreferenceQuery

Returns a query that selects every ColumnPreference record.

pub fn filter(expr: Expr<bool>) -> ColumnPreferenceQuery

Returns a query selecting the ColumnPreference records matching expr.

pub fn delete(self) -> Delete<()>

Consumes this ColumnPreference and returns a statement that deletes its record.

impl ColumnPreference

pub fn upsert_by_key( key: impl IntoExpr<FieldExprTarget<String>>, ) -> ColumnPreferenceUpsertByKey

Returns a builder that creates ColumnPreference or updates the record whose key constraint matches.

The target arguments initialize a new record and remain unchanged when an existing record is updated.

Trait Implementations

impl Assign<ColumnPreference> for ColumnPreference

fn into_assignment(self) -> Assignment<ColumnPreference>

Convert into an Assignment<T> value.

fn assign(self, assignments: &mut Assignments, projection: Projection)

where Self: Sized,

Record one or more assignments into the given [Assignments] map at the specified projection.

impl Clone for ColumnPreference

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 ColumnPreference

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

Formats the value using the given formatter.

impl IntoExpr<ColumnPreference> for ColumnPreference

fn into_expr(self) -> Expr<ColumnPreference>

Consume self and produce an Expr<T>.

fn by_ref(&self) -> Expr<ColumnPreference>

Produce an Expr<T> from a reference without consuming self.

impl IntoStatement for &ColumnPreference

type Returning = ColumnPreference

The type this statement produces when executed.

fn into_statement(self) -> Statement<ColumnPreference>

Consume self and produce the Statement.

impl IntoStatement for &mut ColumnPreference

type Returning = ColumnPreference

The type this statement produces when executed.

fn into_statement(self) -> Statement<ColumnPreference>

Consume self and produce the Statement.

impl IntoStatement for ColumnPreference

type Returning = ColumnPreference

The type this statement produces when executed.

fn into_statement(self) -> Statement<ColumnPreference>

Consume self and produce the Statement.

impl Load for ColumnPreference

type Output = ColumnPreference

The concrete type produced by load.

fn ty() -> Type

Returns the stmt::Type that describes values of this type.

fn load(value: Value) -> Result<Self>

Deserialize a database Value into Self::Output.

fn reload(target: &mut Self, value: Value) -> Result<()>

Reload the value in-place from a value returned by the database.

fn ty_relation() -> Type

Returns the stmt::Type used when this type appears as a relation target. The default delegates to ty().

fn load_relation(value: Value) -> Result<Self::Output, Error>

Deserialize a value that was loaded as a relation target.

impl Model for ColumnPreference

type Query<__T> = ColumnPreferenceQuery<__T>

Query builder for this model, parameterized by what it executes to.

type Create = ColumnPreferenceCreate

Create builder type for this model

type Update<'a> = ColumnPreferenceUpdate<&'a mut ColumnPreference>

Update builder type for this model

type UpdateQuery = ColumnPreferenceUpdate

Update by query builder type for this model

type Path<__Origin> = ColumnPreferenceFields<__Origin>

A typed path from Origin into this model.

type PrimaryKey = String

The model’s primary key type.

type ManyField<__Origin> = ColumnPreferenceListFields<__Origin>

The field accessor type used when this model appears as the “many” side of a has-many relation, parameterized by the origin model.

type OneField<__Origin, __Target> = ColumnPreferenceFields<__Origin, __Target>

The field accessor for a singular relation to this model, parameterized by the origin and path target.

fn id() -> ModelId

Unique identifier for this model within the schema.

fn schema() -> Model

Returns the schema definition for this model.

fn register(model_set: &mut ModelSet)

Register this model and all models reachable through its fields into the given ModelSet.

fn new_path<__Origin>(path: Path<__Origin, Self>) -> Self::Path<__Origin>

Construct a model path from a Path targeting this model.

fn new_many_field<__Origin>( path: Path<__Origin, List<Self>>, ) -> ColumnPreferenceListFields<__Origin>

Construct a ManyField from a path targeting a list of this model.

fn find_by_primary_key(id: Expr<Self::PrimaryKey>) -> Self::Query<List<Self>>

Build a query that filters this model by its primary key.

fn wrap_query<__T>(stmt: Query<__T>) -> Self::Query<__T>

Wrap a raw statement-level Query in this model’s query builder, preserving the result shape T. This is the single constructor generic code uses to build any query shape; callers narrow at the statement level (.one(), .first()) before wrapping.

fn query_one(query: Self::Query<List<Self>>) -> Self::Query<Self>

Narrow a list query to a single-row query (errors at exec time if no row matches). Used by the codegen for non-nullable relation accessors.

fn query_first(query: Self::Query<List<Self>>) -> Self::Query<Option<Self>>

Narrow a list query to an optional single-row query. Used by the codegen for nullable relation accessors.

fn field_name_to_id(name: &str) -> FieldId

Map a field name string to its FieldId.

fn new_root_path() -> Self::Path<Self>

Construct a path rooted at this model.

fn path_root() -> Path<Self, Self>

An identity Path rooted at this model.

fn path_field<U>(index: usize) -> Path<Self, U>

A Path from this model to the field at index.

fn path_model_list() -> Path<List<Self>, List<Self>>

An identity Path rooted at a list of this model, used as the root of has-many relation scopes.

fn new_create() -> Self::Create

Return a fresh, default-initialized create builder.

impl ModelCodegen for ColumnPreference

fn to_relation_expr(&self, fields: &[&str]) -> Expr

Encode referenced fields so the engine can resolve a relation key.

fn new_one_field<__Origin, __Target>( path: Path<__Origin, __Target>, ) -> Self::OneField<__Origin, __Target>

Construct the field accessor for a singular relation to this model.

impl UpdateTarget for &mut ColumnPreference

type Returning = ColumnPreference

The type parameter for the typed Update<R> statement.

fn to_update_stmt( &mut self, assignments: Assignments, ) -> Update<ColumnPreference>

Build the update statement by combining this target’s selection with the provided assignments.

fn apply_result(self, value: Value) -> Result<()>

Apply the result of an update operation.

impl ViaTarget for ColumnPreference

type Query = ColumnPreferenceQuery

The query builder returned by the generated has-many-via navigation method.

type Path<__Origin> = <ColumnPreference as Model>::ManyField<__Origin>

The typed path handle a #[has_many(via = …)] field’s accessor returns, parameterized by the origin model. Mirrors Model::Path for the via-many case.

fn new_path<__Origin>( path: Path<__Origin, List<ColumnPreference>>, ) -> Self::Path<__Origin>

Build the Path handle from the typed path reaching this terminal. A model terminal wraps the path in its chainable ManyField; a scalar terminal is a leaf, so the path is the handle.

fn via_field_ty(singular: Name, path: Path) -> FieldTy

Build the FieldTy::Via for a #[has_many(via = …)] field whose terminal element type is Self.

fn make_via_query(assoc: Association<List<ColumnPreference>>) -> Self::Query

Wrap a via-field association into the navigation query.