Trait BaseModel 

pub trait BaseModel: Serialize + DeserializeOwned {
    const NAME: &'static str;

    // Required methods
    fn get_extension_list() -> &'static ModelExtensionList;
    fn get_extension_data(&self) -> &ModelExtensionData;
    fn base_columns(
        prefix: Option<&str>,
    ) -> BTreeMap<&'static str, CompactString>;
    fn map(prefix: Option<&str>, row: &PgRow) -> Result<Self, DatabaseError>;

    // Provided methods
    fn register_model_extension(
        extension: impl ModelExtension + Send + Sync + 'static,
    ) { ... }
    fn parse_model_extension<Extension: SafeModelExtension>(
        &self,
    ) -> Result<Extension::Value, DatabaseError>
       where Extension::Value: Serialize + DeserializeOwned { ... }
    fn columns(prefix: Option<&str>) -> BTreeMap<&'static str, CompactString> { ... }
    fn columns_sql(prefix: Option<&str>) -> CompactString { ... }
    fn map_extensions(
        prefix: &str,
        row: &PgRow,
    ) -> Result<ModelExtensionData, DatabaseError> { ... }
}

Required Associated Constants

const NAME: &'static str

Required Methods

fn get_extension_list() -> &'static ModelExtensionList

fn get_extension_data(&self) -> &ModelExtensionData

fn base_columns(prefix: Option<&str>) -> BTreeMap<&'static str, CompactString>

fn map(prefix: Option<&str>, row: &PgRow) -> Result<Self, DatabaseError>

Provided Methods

fn register_model_extension( extension: impl ModelExtension + Send + Sync + 'static, )

Registers a model extension. If an extension with the same name is already registered, this function will do nothing.

fn parse_model_extension<Extension: SafeModelExtension>( &self, ) -> Result<Extension::Value, DatabaseError>

where Extension::Value: Serialize + DeserializeOwned,

Parses a model extension from the model’s extension data. If the extension is not found, or if the data cannot be deserialized, an error is returned.

This can be costly depending on what is stored, so use sparingly.

fn columns(prefix: Option<&str>) -> BTreeMap<&'static str, CompactString>

fn columns_sql(prefix: Option<&str>) -> CompactString

fn map_extensions( prefix: &str, row: &PgRow, ) -> Result<ModelExtensionData, DatabaseError>

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl BaseModel for AdminActivity

const NAME: &'static str = "admin_activity"

impl BaseModel for Announcement

const NAME: &'static str = "announcement"

impl BaseModel for BackupConfiguration

const NAME: &'static str = "backup_configuration"

impl BaseModel for DatabaseHost

const NAME: &'static str = "database_host"

impl BaseModel for EggConfiguration

const NAME: &'static str = "egg_configuration"

impl BaseModel for EggRepository

const NAME: &'static str = "egg_repository"

impl BaseModel for EggRepositoryEgg

const NAME: &'static str = "egg_repository_egg"

impl BaseModel for Location

const NAME: &'static str = "location"

impl BaseModel for LocationDatabaseHost

const NAME: &'static str = "location_database_host"

impl BaseModel for Mount

const NAME: &'static str = "mount"

impl BaseModel for Nest

const NAME: &'static str = "nest"

impl BaseModel for NestEgg

const NAME: &'static str = "nest_egg"

impl BaseModel for NestEggMount

const NAME: &'static str = "nest_egg_mount"

impl BaseModel for NestEggVariable

const NAME: &'static str = "nest_egg_variable"

impl BaseModel for Node

const NAME: &'static str = "node"

impl BaseModel for NodeAllocation

const NAME: &'static str = "node_allocation"

impl BaseModel for NodeMount

const NAME: &'static str = "node_mount"

impl BaseModel for OAuthProvider

const NAME: &'static str = "oauth_provider"

impl BaseModel for Role

const NAME: &'static str = "role"

impl BaseModel for Server

const NAME: &'static str = "server"

impl BaseModel for ServerActivity

const NAME: &'static str = "server_activity"

impl BaseModel for ServerAllocation

const NAME: &'static str = "server_allocation"

impl BaseModel for ServerBackup

const NAME: &'static str = "server_backup"

impl BaseModel for ServerDatabase

const NAME: &'static str = "server_database"

impl BaseModel for ServerMount

const NAME: &'static str = "server_mount"

impl BaseModel for ServerSchedule

const NAME: &'static str = "server_schedule"

impl BaseModel for ServerScheduleStep

const NAME: &'static str = "server_schedule_step"

impl BaseModel for ServerSubuser

const NAME: &'static str = "server_subuser"

impl BaseModel for ServerVariable

const NAME: &'static str = "server_variable"

impl BaseModel for User

const NAME: &'static str = "user"

impl BaseModel for UserActivity

const NAME: &'static str = "user_activity"

impl BaseModel for UserApiKey

const NAME: &'static str = "user_api_key"

impl BaseModel for UserCommandSnippet

const NAME: &'static str = "user_command_snippet"

impl BaseModel for UserOAuthLink

const NAME: &'static str = "user_oauth_link"

impl BaseModel for UserPasswordReset

const NAME: &'static str = "user_password_reset"

impl BaseModel for UserRecoveryCode

const NAME: &'static str = "user_recovery_code"

impl BaseModel for UserSecurityKey

const NAME: &'static str = "user_security_key"

impl BaseModel for UserServerGroup

const NAME: &'static str = "user_server_group"

impl BaseModel for UserSession

const NAME: &'static str = "user_session"

impl BaseModel for UserSshKey

const NAME: &'static str = "user_ssh_key"