Skip to main content

ModelConfig

Struct ModelConfig 

Source
pub struct ModelConfig {
    pub table: bool,
    pub from_attributes: bool,
    pub validate_assignment: bool,
    pub extra: ExtraFieldsBehavior,
    pub strict: bool,
    pub populate_by_name: bool,
    pub use_enum_values: bool,
    pub arbitrary_types_allowed: bool,
    pub defer_build: bool,
    pub revalidate_instances: bool,
    pub json_schema_extra: Option<&'static str>,
    pub title: Option<&'static str>,
}
Expand description

Model-level configuration matching Pydantic’s model_config.

This struct holds configuration options that affect model behavior during validation, serialization, and database operations.

§Example

#[derive(Model)]
#[sqlmodel(
    table,
    from_attributes,
    validate_assignment,
    extra = "forbid",
    strict,
    populate_by_name,
    use_enum_values
)]
struct User {
    // ...
}

Fields§

§table: bool

Whether this model maps to a database table. If true, DDL can be generated for this model.

§from_attributes: bool

Allow reading data from object attributes (ORM mode). When true, model_validate can accept objects with attributes in addition to dicts.

§validate_assignment: bool

Validate field values when they are assigned. When true, assignment to fields triggers validation.

§extra: ExtraFieldsBehavior

How to handle extra fields during validation.

§strict: bool

Enable strict type checking during validation. When true, types must match exactly (no coercion).

§populate_by_name: bool

Allow populating fields by either name or alias. When true, both the field name and any aliases are accepted during deserialization.

§use_enum_values: bool

Use enum values instead of names during serialization. When true, enum fields serialize to their underlying values rather than variant names.

§arbitrary_types_allowed: bool

Allow arbitrary types in fields. When true, fields can use types that aren’t natively supported by the validation system.

§defer_build: bool

Defer model validation to allow forward references. When true, validation of field types is deferred until the model is first used.

§revalidate_instances: bool

Revalidate instances when converting to this model. Controls whether existing model instances are revalidated.

§json_schema_extra: Option<&'static str>

Custom JSON schema extra data. Additional data to include in generated JSON schema.

§title: Option<&'static str>

Title for JSON schema generation.

Implementations§

Source§

impl ModelConfig

Source

pub const fn new() -> Self

Create a new ModelConfig with all defaults.

Source

pub const fn table() -> Self

Create a config for a database table model.

Trait Implementations§

Source§

impl Clone for ModelConfig

Source§

fn clone(&self) -> ModelConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModelConfig

Source§

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

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

impl Default for ModelConfig

Source§

fn default() -> ModelConfig

Returns the “default value” for a type. Read more

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<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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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