Trait butane_core::DataObject

pub trait DataObject: DataResult<DBO = Self> {
    type PKType: PrimaryKeyType;
    type Fields: Default;

    const PKCOL: &'static str;
    const TABLE: &'static str;

    fn pk(&self) -> &Self::PKType;
    fn save(&mut self, conn: &impl ConnectionMethods) -> Result<()>;
    fn delete(&self, conn: &impl ConnectionMethods) -> Result<()>;

    fn get(
        conn: &impl ConnectionMethods, 
        id: impl Borrow<Self::PKType>
    ) -> Result<Self>
    where
        Self: Sized,
    { ... }
}

An object in the database.

Rather than implementing this type manually, use the #[model] attribute.

Associated Types

type PKType: PrimaryKeyType

The type of the primary key field.

type Fields: Default

Associated Constants

const PKCOL: &'static str

The name of the primary key column.

const TABLE: &'static str

The name of the table.

Required methods

fn pk(&self) -> &Self::PKType

Get the primary key

fn save(&mut self, conn: &impl ConnectionMethods) -> Result<()>

Save the object to the database.

fn delete(&self, conn: &impl ConnectionMethods) -> Result<()>

Delete the object from the database.

Provided methods

fn get(
    conn: &impl ConnectionMethods,
    id: impl Borrow<Self::PKType>
) -> Result<Self> where
    Self: Sized, 

Find this object in the database based on primary key.

Implementors