Trait Indexable

Source

pub trait Indexable: DbcTable {
    type PrimaryKey;

    // Required methods
    fn get(&self, key: impl TryInto<Self::PrimaryKey>) -> Option<&Self::Row>;
    fn get_mut(
        &mut self,
        key: impl TryInto<Self::PrimaryKey>,
    ) -> Option<&mut Self::Row>;
}

Expand description

Implemented by tables that have a primary key.

This is a separate trait instead of just implementing std::ops::Index and std::ops::IndexMut since those traits do not return Options and only have the possibility of panicking on invalid keys.

The original DBCs do not really respect primary/foreign keys, so this just seemed like it would make everything more annoying.

Required Associated Types§

Source

type PrimaryKey

Key used to index into the table. Same name as the table suffixed with Key.

Required Methods§

Source

fn get(&self, key: impl TryInto<Self::PrimaryKey>) -> Option<&Self::Row>

Gets the primary key, if present. Internally this is just std::iter::Iterator::find since the items are not guaranteed to be ordered nor even be present.

Source

fn get_mut( &mut self, key: impl TryInto<Self::PrimaryKey>, ) -> Option<&mut Self::Row>

Gets the primary key, if present. Internally this is just std::iter::Iterator::find since the items are not guaranteed to be ordered nor even be present.

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.

Trait IndexableCopy item path

Required Associated Types§

type PrimaryKey

Required Methods§

fn get(&self, key: impl TryInto<Self::PrimaryKey>) -> Option<&Self::Row>

fn get_mut( &mut self, key: impl TryInto<Self::PrimaryKey>, ) -> Option<&mut Self::Row>

Dyn Compatibility§

Implementors§

impl Indexable for wow_dbc::tbc_tables::animation_data::AnimationData

type PrimaryKey = AnimationDataKey

impl Indexable for wow_dbc::tbc_tables::area_poi::AreaPOI

type PrimaryKey = AreaPOIKey

impl Indexable for wow_dbc::tbc_tables::area_table::AreaTable

type PrimaryKey = AreaTableKey

impl Indexable for wow_dbc::tbc_tables::area_trigger::AreaTrigger

type PrimaryKey = AreaTriggerKey

impl Indexable for wow_dbc::tbc_tables::attack_anim_kits::AttackAnimKits

type PrimaryKey = AttackAnimKitsKey

impl Indexable for wow_dbc::tbc_tables::auction_house::AuctionHouse

type PrimaryKey = AuctionHouseKey

impl Indexable for wow_dbc::tbc_tables::bank_bag_slot_prices::BankBagSlotPrices

type PrimaryKey = BankBagSlotPricesKey

impl Indexable for wow_dbc::tbc_tables::battlemaster_list::BattlemasterList

type PrimaryKey = BattlemasterListKey

impl Indexable for wow_dbc::tbc_tables::camera_shakes::CameraShakes

type PrimaryKey = CameraShakesKey

impl Indexable for wow_dbc::tbc_tables::cfg_categories::Cfg_Categories

type PrimaryKey = Cfg_CategoriesKey

impl Indexable for wow_dbc::tbc_tables::cfg_configs::Cfg_Configs

type PrimaryKey = Cfg_ConfigsKey

impl Indexable for wow_dbc::tbc_tables::char_hair_geosets::CharHairGeosets

type PrimaryKey = CharHairGeosetsKey

impl Indexable for wow_dbc::tbc_tables::char_hair_textures::CharHairTextures

type PrimaryKey = CharHairTexturesKey

impl Indexable for wow_dbc::tbc_tables::char_sections::CharSections

type PrimaryKey = CharSectionsKey

impl Indexable for wow_dbc::tbc_tables::char_start_outfit::CharStartOutfit

type PrimaryKey = CharStartOutfitKey

impl Indexable for wow_dbc::tbc_tables::char_titles::CharTitles

type PrimaryKey = CharTitlesKey

impl Indexable for wow_dbc::tbc_tables::chat_channels::ChatChannels

type PrimaryKey = ChatChannelsKey

impl Indexable for wow_dbc::tbc_tables::chat_profanity::ChatProfanity

type PrimaryKey = ChatProfanityKey

impl Indexable for wow_dbc::tbc_tables::chr_classes::ChrClasses

type PrimaryKey = ChrClassesKey

impl Indexable for wow_dbc::tbc_tables::chr_races::ChrRaces

type PrimaryKey = ChrRacesKey

impl Indexable for wow_dbc::tbc_tables::cinematic_camera::CinematicCamera

type PrimaryKey = CinematicCameraKey

impl Indexable for wow_dbc::tbc_tables::cinematic_sequences::CinematicSequences

type PrimaryKey = CinematicSequencesKey

impl Indexable for wow_dbc::tbc_tables::creature_display_info::CreatureDisplayInfo

type PrimaryKey = CreatureDisplayInfoKey

impl Indexable for wow_dbc::tbc_tables::creature_display_info_extra::CreatureDisplayInfoExtra

type PrimaryKey = CreatureDisplayInfoExtraKey

impl Indexable for wow_dbc::tbc_tables::creature_family::CreatureFamily

type PrimaryKey = CreatureFamilyKey

impl Indexable for wow_dbc::tbc_tables::creature_model_data::CreatureModelData

type PrimaryKey = CreatureModelDataKey

impl Indexable for wow_dbc::tbc_tables::creature_sound_data::CreatureSoundData

type PrimaryKey = CreatureSoundDataKey

impl Indexable for wow_dbc::tbc_tables::creature_spell_data::CreatureSpellData

type PrimaryKey = CreatureSpellDataKey

impl Indexable for wow_dbc::tbc_tables::creature_type::CreatureType

type PrimaryKey = CreatureTypeKey

impl Indexable for wow_dbc::tbc_tables::death_thud_lookups::DeathThudLookups

type PrimaryKey = DeathThudLookupsKey

impl Indexable for wow_dbc::tbc_tables::declined_word::DeclinedWord

type PrimaryKey = DeclinedWordKey

impl Indexable for wow_dbc::tbc_tables::declined_word_cases::DeclinedWordCases

type PrimaryKey = DeclinedWordCasesKey

impl Indexable for wow_dbc::tbc_tables::durability_costs::DurabilityCosts

type PrimaryKey = DurabilityCostsKey

impl Indexable for wow_dbc::tbc_tables::durability_quality::DurabilityQuality

type PrimaryKey = DurabilityQualityKey

impl Indexable for wow_dbc::tbc_tables::emotes::Emotes

type PrimaryKey = EmotesKey

impl Indexable for wow_dbc::tbc_tables::emotes_text::EmotesText

type PrimaryKey = EmotesTextKey

Trait Indexable