Struct df_st_db::UndergroundRegion

pub struct UndergroundRegion {
    pub id: i32,
    pub world_id: i32,
    pub type_: Option<String>,
    pub depth: Option<i32>,
}

Fields

id: i32

world_id: i32

type_: Option<String>

depth: Option<i32>

Implementations

impl UndergroundRegion

pub fn new() -> Self

Trait Implementations

impl<'update> AsChangeset for &'update UndergroundRegion

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<world_id, &'update i32>, Option<Eq<type_, &'update String>>, Option<Eq<depth, &'update i32>>) 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 UndergroundRegion

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<world_id, i32>, Option<Eq<type_, String>>, Option<Eq<depth, i32>>) 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 BelongsTo<UndergroundRegion> for Coordinate

type ForeignKey = i32

The foreign key of this struct

type ForeignKeyColumn = underground_region_id

The database column representing the foreign key of the table this struct represents

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct's table

impl Clone for UndergroundRegion

fn clone(&self) -> UndergroundRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DBObject<UndergroundRegion, UndergroundRegion> for UndergroundRegion

fn add_missing_data_advanced(core_world: &DFWorld, world: &mut DBDFWorld)

Add Coordinates to the world that are part of UndergroundRegion

fn insert_into_db(conn: &DbConnection, ug_regions: &[UndergroundRegion])

Insert the DB object into the database

fn find_db_item(
    conn: &DbConnection,
    id_filter: HashMap<String, i32>
) -> Result<Option<UndergroundRegion>, 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<UndergroundRegion>, 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: &[UndergroundRegion],
    _core_list: Vec<UndergroundRegion>
) -> Result<Vec<UndergroundRegion>, 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 UndergroundRegion

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

Formats the value using the given formatter.

impl Default for UndergroundRegion

fn default() -> UndergroundRegion

Returns the "default value" for a type.

impl Fillable for UndergroundRegion

impl Filler<UndergroundRegion, UndergroundRegion> for UndergroundRegion

From Core to DB

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

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<UndergroundRegion, UndergroundRegion> for UndergroundRegion

From DB to Core

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

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 UndergroundRegion

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 UndergroundRegion

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 UndergroundRegion

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 UndergroundRegion

type Values = <(Option<Eq<id, i32>>, Option<Eq<world_id, i32>>, Option<Eq<type_, String>>, Option<Eq<depth, i32>>) 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 UndergroundRegion

type Values = <(Option<Eq<id, &'insert i32>>, Option<Eq<world_id, &'insert i32>>, Option<Eq<type_, &'insert String>>, Option<Eq<depth, &'insert i32>>) 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<UndergroundRegion> for UndergroundRegion

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<UndergroundRegion> for UndergroundRegion

fn eq(&self, other: &UndergroundRegion) -> 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<UndergroundRegion> for UndergroundRegion

fn eq(&self, other: &UndergroundRegion) -> 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 UndergroundRegion where
    (i32, i32, Option<String>, Option<i32>): Queryable<__ST, __DB>, 

type Row = <(i32, i32, Option<String>, Option<i32>) 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 UndergroundRegion