Struct df_st_db::Artifact

pub struct Artifact {
    pub id: i32,
    pub world_id: i32,
    pub name: Option<String>,
    pub site_id: Option<i32>,
    pub structure_local_id: Option<i32>,
    pub holder_hfid: Option<i32>,
    pub abs_tile_x: Option<i32>,
    pub abs_tile_y: Option<i32>,
    pub abs_tile_z: Option<i32>,
    pub subregion_id: Option<i32>,
    pub item_name: Option<String>,
    pub item_type: Option<String>,
    pub item_subtype: Option<String>,
    pub item_writing: Option<i32>,
    pub item_page_number: Option<i32>,
    pub item_page_written_content_id: Option<i32>,
    pub item_writing_written_content_id: Option<i32>,
    pub item_description: Option<String>,
    pub item_mat: Option<String>,
}

Fields

id: i32

world_id: i32

name: Option<String>

site_id: Option<i32>

structure_local_id: Option<i32>

holder_hfid: Option<i32>

abs_tile_x: Option<i32>

abs_tile_y: Option<i32>

abs_tile_z: Option<i32>

subregion_id: Option<i32>

item_name: Option<String>

item_type: Option<String>

item_subtype: Option<String>

item_writing: Option<i32>

item_page_number: Option<i32>

item_page_written_content_id: Option<i32>

item_writing_written_content_id: Option<i32>

item_description: Option<String>

item_mat: Option<String>

Implementations

impl Artifact

pub fn new() -> Self

Trait Implementations

impl<'update> AsChangeset for &'update Artifact

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<world_id, &'update i32>, Option<Eq<name, &'update String>>, Option<Eq<site_id, &'update i32>>, Option<Eq<structure_local_id, &'update i32>>, Option<Eq<holder_hfid, &'update i32>>, Option<Eq<abs_tile_x, &'update i32>>, Option<Eq<abs_tile_y, &'update i32>>, Option<Eq<abs_tile_z, &'update i32>>, Option<Eq<subregion_id, &'update i32>>, Option<Eq<item_name, &'update String>>, Option<Eq<item_type, &'update String>>, Option<Eq<item_subtype, &'update String>>, Option<Eq<item_writing, &'update i32>>, Option<Eq<item_page_number, &'update i32>>, Option<Eq<item_page_written_content_id, &'update i32>>, Option<Eq<item_writing_written_content_id, &'update i32>>, Option<Eq<item_description, &'update String>>, Option<Eq<item_mat, &'update String>>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl<'update> AsChangeset for Artifact

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<world_id, i32>, Option<Eq<name, String>>, Option<Eq<site_id, i32>>, Option<Eq<structure_local_id, i32>>, Option<Eq<holder_hfid, i32>>, Option<Eq<abs_tile_x, i32>>, Option<Eq<abs_tile_y, i32>>, Option<Eq<abs_tile_z, i32>>, Option<Eq<subregion_id, i32>>, Option<Eq<item_name, String>>, Option<Eq<item_type, String>>, Option<Eq<item_subtype, String>>, Option<Eq<item_writing, i32>>, Option<Eq<item_page_number, i32>>, Option<Eq<item_page_written_content_id, i32>>, Option<Eq<item_writing_written_content_id, i32>>, Option<Eq<item_description, String>>, Option<Eq<item_mat, String>>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl Clone for Artifact

fn clone(&self) -> Artifact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DBObject<Artifact, Artifact> for Artifact

fn add_missing_data_advanced(_core_world: &DFWorld, _world: &mut DBDFWorld)

Add other items to the world that are part of DB Object, but are still part of the Core object.

fn insert_into_db(conn: &DbConnection, artifacts: &[Artifact])

Insert the DB object into the database

fn find_db_item(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>
) -> Result<Option<Artifact>, Error>

The database call for an item by id If item not found returns None

fn find_db_list(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>,
    _string_filter: HashMap<String, String>,
    offset: i64,
    limit: i64,
    order: Option<OrderTypes>,
    order_by: Option<String>,
    id_list: Option<Vec<i32>>
) -> Result<Vec<Artifact>, Error>

The database call for the list of items given some limit Limit: the maximum amount of items in the list that are returned.

fn match_field_by(field: String) -> String

fn add_nested_items(
    _conn: &DbConnection,
    _db_list: &[Artifact],
    core_list: Vec<Artifact>
) -> Result<Vec<Artifact>, Error>

Add additional data to the list of objects This can call additional DB requests

fn get_count_from_db(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>,
    _string_filter: HashMap<String, String>,
    offset: u32,
    limit: u32,
    group_by_opt: Option<String>,
    id_list: Option<Vec<i32>>
) -> Result<Vec<ItemCount>, Error>

Get the amount of items that would be returned when using these filters. The fields can optionally be grouped using the group_by_opt.

fn get_order(
    order: Option<OrderTypes>,
    order_by: Option<String>
) -> (String, bool)

fn match_field_by_opt(field: Option<String>) -> Option<String>

fn insert_into_db_chunked(conn: &DbConnection, db_list: &[D])

Inserts the DB objects into the database. If the list is to long to insert in 1 database call it will split it up in chunks and insert them in multiple calls. See #46

fn insert_into_db_chunked_indexmap(
    conn: &DbConnection,
    db_list: &IndexMap<u64, D>
)

Inserts the DB objects into the database. If the list is to long to insert in 1 database call it will split it up in chunks and insert them in multiple calls. See #46

fn indexmap_chunks(
    indexmap: &IndexMap<u64, D>,
    chunk_size: usize,
    offset: usize
) -> Vec<D>

fn get_list_from_db(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>,
    string_filter: HashMap<String, String>,
    offset: u32,
    limit: u32,
    order: Option<OrderTypes>,
    order_by: Option<String>,
    id_list: Option<Vec<i32>>,
    add_nested_items: bool
) -> Result<Vec<C>, Error>

Get a list of all the Core items from that database given some parameters Limit: the maximum amount of items in the list that are returned.

fn get_from_db(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>,
    add_nested_items: bool
) -> Result<Option<C>, Error>

Get a Core item from the database, search by id If item is not found it will return None

impl Debug for Artifact

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

Formats the value using the given formatter.

impl Default for Artifact

fn default() -> Artifact

Returns the "default value" for a type.

impl Fillable for Artifact

impl Filler<Artifact, Artifact> for Artifact

From Core to DB

fn add_missing_data(&mut self, source: &Artifact)

Add data to self that is set as None or appends list items. Use source object to get values from.

fn add_missing_data_indexed(&mut self, source: &S, _index: u64)

Add data to self from source. Same ways as add_missing_data. This function is used when adding data when looping over lists. This allows the index to be used. For example as an incremental ID. This function can be overwritten if this ID is wanted.

fn never_replace_data(&mut self, source: &S) where
    Self: Debug, 

Add data to self that is set as None or appends list items. If a value is Some it will leave the value as is.

fn replace_data(&mut self, source: &S) where
    Self: Debug, 

Add data to self. If already some value present, replace it. Appends list items. This is used when there is data that is richer then previous data. It does not trow the not_same_data warning. add_missing_data should be used in most cases instead.

fn check_mergeable(&self, source: &S) -> bool where
    S: PartialEq<Self> + Debug,
    Self: Debug + Default + PartialEq<Self>, 

impl Filler<Artifact, Artifact> for Artifact

From DB to Core

fn add_missing_data(&mut self, source: &Artifact)

Add data to self that is set as None or appends list items. Use source object to get values from.

fn add_missing_data_indexed(&mut self, source: &S, _index: u64)

Add data to self from source. Same ways as add_missing_data. This function is used when adding data when looping over lists. This allows the index to be used. For example as an incremental ID. This function can be overwritten if this ID is wanted.

fn never_replace_data(&mut self, source: &S) where
    Self: Debug, 

Add data to self that is set as None or appends list items. If a value is Some it will leave the value as is.

fn replace_data(&mut self, source: &S) where
    Self: Debug, 

Add data to self. If already some value present, replace it. Appends list items. This is used when there is data that is richer then previous data. It does not trow the not_same_data warning. add_missing_data should be used in most cases instead.

fn check_mergeable(&self, source: &S) -> bool where
    S: PartialEq<Self> + Debug,
    Self: Debug + Default + PartialEq<Self>, 

impl HasTable for Artifact

type Table = table

The table this type is associated with.

fn table() -> Self::Table

Returns the table this type is associated with.

impl Hash for Artifact

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'ident> Identifiable for &'ident Artifact

type Id = &'ident i32

The type of this struct's identifier.

fn id(self) -> Self::Id

Returns the identifier for this record.

impl<'insert> Insertable<table> for Artifact

type Values = <(Option<Eq<id, i32>>, Option<Eq<world_id, i32>>, Option<Eq<name, String>>, Option<Eq<site_id, i32>>, Option<Eq<structure_local_id, i32>>, Option<Eq<holder_hfid, i32>>, Option<Eq<abs_tile_x, i32>>, Option<Eq<abs_tile_y, i32>>, Option<Eq<abs_tile_z, i32>>, Option<Eq<subregion_id, i32>>, Option<Eq<item_name, String>>, Option<Eq<item_type, String>>, Option<Eq<item_subtype, String>>, Option<Eq<item_writing, i32>>, Option<Eq<item_page_number, i32>>, Option<Eq<item_page_written_content_id, i32>>, Option<Eq<item_writing_written_content_id, i32>>, Option<Eq<item_description, String>>, Option<Eq<item_mat, String>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(
    self,
    table: T
) -> InsertStatement<T, Self::Values, Insert, NoReturningClause>

Insert self into a given table.

impl<'insert> Insertable<table> for &'insert Artifact

type Values = <(Option<Eq<id, &'insert i32>>, Option<Eq<world_id, &'insert i32>>, Option<Eq<name, &'insert String>>, Option<Eq<site_id, &'insert i32>>, Option<Eq<structure_local_id, &'insert i32>>, Option<Eq<holder_hfid, &'insert i32>>, Option<Eq<abs_tile_x, &'insert i32>>, Option<Eq<abs_tile_y, &'insert i32>>, Option<Eq<abs_tile_z, &'insert i32>>, Option<Eq<subregion_id, &'insert i32>>, Option<Eq<item_name, &'insert String>>, Option<Eq<item_type, &'insert String>>, Option<Eq<item_subtype, &'insert String>>, Option<Eq<item_writing, &'insert i32>>, Option<Eq<item_page_number, &'insert i32>>, Option<Eq<item_page_written_content_id, &'insert i32>>, Option<Eq<item_writing_written_content_id, &'insert i32>>, Option<Eq<item_description, &'insert String>>, Option<Eq<item_mat, &'insert String>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(
    self,
    table: T
) -> InsertStatement<T, Self::Values, Insert, NoReturningClause>

Insert self into a given table.

impl PartialEq<Artifact> for Artifact

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Artifact> for Artifact

fn eq(&self, other: &Artifact) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Artifact> for Artifact

fn eq(&self, other: &Artifact) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<__DB: Backend, __ST> Queryable<__ST, __DB> for Artifact where
    (i32, i32, Option<String>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<String>, Option<String>, Option<String>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<String>, Option<String>): Queryable<__ST, __DB>, 

type Row = <(i32, i32, Option<String>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<String>, Option<String>, Option<String>, Option<i32>, Option<i32>, Option<i32>, Option<i32>, Option<String>, Option<String>) as Queryable<__ST, __DB>>::Row

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

impl<'insert> UndecoratedInsertRecord<table> for Artifact