var searchIndex = {};
searchIndex["vault"] = {"doc":"vault is a fully-featured Company of Heroes 2 replay parser valid for replays created on or\nafter the release of the British forces (version 19545).","items":[[3,"ChatLine","vault","This type represents a single Company of Heroes 2 chat message.",null,null],[12,"tick","","",0,null],[12,"name","","",0,null],[12,"message","","",0,null],[3,"Command","","This type represents a single Company of Heroes 2 player command.",null,null],[12,"player_id","","",1,null],[12,"tick","","",1,null],[12,"command_type","","",1,null],[12,"entity_id","","",1,null],[12,"x","","",1,null],[12,"y","","",1,null],[12,"z","","",1,null],[12,"bytes","","",1,null],[3,"Config","","This type contains option and configuration information for the associated Vault instance.",null,null],[12,"strict","","",2,null],[12,"commands","","",2,null],[12,"command_bytes","","",2,null],[3,"Item","","This type contains a parsed representation of an item that can be equipped in a CoH2 replay.",null,null],[12,"id","","",3,null],[12,"item_type","","",3,null],[3,"Map","","This type represents a Company of Heroes 2 map as presented in a CoH2 replay file.",null,null],[12,"file","","",4,null],[12,"name","","",4,null],[12,"description","","",4,null],[12,"description_long","","",4,null],[12,"width","","",4,null],[12,"height","","",4,null],[12,"players","","",4,null],[3,"Player","","This type represents a Company of Heroes 2 player entity as it appears in a CoH2 replay file.",null,null],[12,"id","","",5,null],[12,"name","","",5,null],[12,"steam_id","","",5,null],[12,"team","","",5,null],[12,"faction","","",5,null],[12,"items","","",5,null],[12,"commands","","",5,null],[12,"cpm","","",5,null],[3,"Replay","","The main Replay type, contains all currently parsed replay data. Can be serialized to JSON for\noutput using rustc_serialize.",null,null],[12,"error","","",6,null],[12,"version","","",6,null],[12,"game_type","","",6,null],[12,"date_time","","",6,null],[12,"map","","",6,null],[12,"players","","",6,null],[12,"duration","","",6,null],[12,"rng_seed","","",6,null],[12,"opponent_type","","",6,null],[12,"chat","","",6,null],[3,"Vault","","This type is the main entry point for the vault replay parser and provides the cleanest\ninterface for use by external code.",null,null],[12,"replays","","",7,null],[4,"CmdType","","This type contains a numerical u8 representation of every command/action possible in a CoH2 command\nsequence. Contents of this enum provided by Relic Entertainment.",null,null],[13,"CMD_DefaultAction","","",8,null],[13,"CMD_Stop","","",8,null],[13,"CMD_Destroy","","",8,null],[13,"CMD_BuildSquad","","",8,null],[13,"CMD_InstantBuildSquad","","",8,null],[13,"CMD_CancelProduction","","",8,null],[13,"CMD_BuildStructure","","",8,null],[13,"CMD_Move","","",8,null],[13,"CMD_Face","","",8,null],[13,"CMD_Attack","","",8,null],[13,"CMD_AttackMove","","",8,null],[13,"CMD_RallyPoint","","",8,null],[13,"CMD_Capture","","",8,null],[13,"CMD_Ability","","",8,null],[13,"CMD_Evacuate","","",8,null],[13,"CMD_Upgrade","","",8,null],[13,"CMD_InstantUpgrade","","",8,null],[13,"CMD_ChooseResource","","",8,null],[13,"CMD_Load","","",8,null],[13,"CMD_Unload","","",8,null],[13,"CMD_UnloadSquads","","",8,null],[13,"CMD_AttackStop","","",8,null],[13,"CMD_AttackForced","","",8,null],[13,"CMD_SetHoldHeading","","",8,null],[13,"CMD_Halt","","",8,null],[13,"CMD_Fidget","","",8,null],[13,"CMD_Paradrop","","",8,null],[13,"CMD_DefuseMine","","",8,null],[13,"CMD_Casualty","","",8,null],[13,"CMD_Death","","",8,null],[13,"CMD_InstantDeath","","",8,null],[13,"CMD_Projectile","","",8,null],[13,"CMD_PlaceCharge","","",8,null],[13,"CMD_BuildEntity","","",8,null],[13,"CMD_RescueCasualty","","",8,null],[13,"CMD_AttackFromHold","","",8,null],[13,"CMD_Vault","","",8,null],[13,"CMD_COUNT","","",8,null],[13,"SCMD_Move","","",8,null],[13,"SCMD_Stop","","",8,null],[13,"SCMD_Destroy","","",8,null],[13,"SCMD_BuildStructure","","",8,null],[13,"SCMD_Capture","","",8,null],[13,"SCMD_Attack","","",8,null],[13,"SCMD_ReinforceUnit","","",8,null],[13,"SCMD_Upgrade","","",8,null],[13,"SCMD_CancelProduction","","",8,null],[13,"SCMD_AttackMove","","",8,null],[13,"SCMD_Ability","","",8,null],[13,"SCMD_Load","","",8,null],[13,"SCMD_InstantLoad","","",8,null],[13,"SCMD_UnloadSquads","","",8,null],[13,"SCMD_Unload","","",8,null],[13,"SCMD_SlotItemRemove","","",8,null],[13,"SCMD_Retreat","","",8,null],[13,"SCMD_CaptureTeamWeapon","","",8,null],[13,"SCMD_SetMoveType","","",8,null],[13,"SCMD_InstantReinforceUnit","","",8,null],[13,"SCMD_InstantUpgrade","","",8,null],[13,"SCMD_SetCamouflageStance","","",8,null],[13,"SCMD_PlaceCharge","","",8,null],[13,"SCMD_DefuseCharge","","",8,null],[13,"SCMD_PickUpSlotItem","","",8,null],[13,"SCMD_DefuseMine","","",8,null],[13,"SCMD_DoPlan","","",8,null],[13,"SCMD_Patrol","","",8,null],[13,"SCMD_Surprise","","",8,null],[13,"SCMD_InstantSetupTeamWeapon","","",8,null],[13,"SCMD_AbandonTeamWeapon","","",8,null],[13,"SCMD_StationaryAttack","","",8,null],[13,"SCMD_RevertFieldSupport","","",8,null],[13,"SCMD_Face","","",8,null],[13,"SCMD_BuildSquad","","",8,null],[13,"SCMD_RallyPoint","","",8,null],[13,"SCMD_RescueCasualty","","",8,null],[13,"SCMD_Recrew","","",8,null],[13,"SCMD_Merge","","",8,null],[13,"SCMD_Pilfer","","",8,null],[13,"SCMD_COUNT","","",8,null],[13,"PCMD_ConstructStructure","","",8,null],[13,"PCMD_ManpowerDonation","","",8,null],[13,"PCMD_FuelDonation","","",8,null],[13,"PCMD_MunitionDonation","","",8,null],[13,"PCMD_CheatResources","","",8,null],[13,"PCMD_CheatRevealAll","","",8,null],[13,"PCMD_CheatKillSelf","","",8,null],[13,"PCMD_Ability","","",8,null],[13,"PCMD_CheatBuildTime","","",8,null],[13,"PCMD_CriticalHit","","",8,null],[13,"PCMD_Upgrade","","",8,null],[13,"PCMD_InstantUpgrade","","",8,null],[13,"PCMD_ConstructFence","","",8,null],[13,"PCMD_ConstructField","","",8,null],[13,"PCMD_UpgradeRemove","","",8,null],[13,"PCMD_SlotItemRemove","","",8,null],[13,"PCMD_CancelProduction","","",8,null],[13,"PCMD_DetonateCharges","","",8,null],[13,"PCMD_AIPlayer","","",8,null],[13,"PCMD_AIPlayer_ObjectiveNotification","","",8,null],[13,"PCMD_SetCommander","","",8,null],[13,"PCMD_Surrender","","",8,null],[13,"PCMD_WaitObjectDone","","",8,null],[13,"PCMD_BroadcastMessage","","",8,null],[13,"PCMD_COUNT","","",8,null],[13,"DCMD_DataCommand1","","",8,null],[13,"DCMD_DataCommand2","","",8,null],[13,"DCMD_COUNT","","",8,null],[4,"Error","","This type contains the various error messages that can be returned from the library.",null,null],[13,"CursorWrap","","",9,null],[13,"CursorOutOfBounds","","",9,null],[13,"FileTooLarge","","",9,null],[13,"EmptyChar","","",9,null],[13,"InvalidFileExtension","","",9,null],[13,"UnexpectedValue","","",9,null],[13,"UnsupportedVersion","","",9,null],[13,"UnsupportedChunkVersion","","",9,null],[13,"IoError","","",9,null],[13,"Utf8Error","","",9,null],[13,"Utf16Error","","",9,null],[13,"ZipError","","",9,null],[13,"EncoderError","","",9,null],[5,"print_version","","Prints out the current vault version and compatible CoH2 game versions.",null,{"inputs":[],"output":null}],[11,"encode","","",0,null],[11,"fmt","","",0,null],[11,"with_data","","Constructs a new ChatLine initialized with the data given.",0,{"inputs":[{"name":"u32"},{"name":"s"},{"name":"s"}],"output":{"name":"chatline"}}],[11,"display","","Writes the contents of the ChatLine to stdout.",0,null],[11,"encode","","",1,null],[11,"fmt","","",1,null],[11,"new","","Constructs a new, empty Command.",1,{"inputs":[{"name":"u32"},{"name":"cmdtype"}],"output":{"name":"command"}}],[11,"display","","Writes the contents of the Command to stdout.",1,null],[11,"encode","","",8,null],[11,"eq","","",8,null],[11,"clone","","",8,null],[11,"fmt","","",8,null],[11,"from_u8","","Converts a numerical representation of a CmdType enum into the correct enum value by\nunsafely transmuting the numerical representation into the CmdType type.",8,{"inputs":[{"name":"u8"}],"output":{"name":"option"}}],[11,"encode","","",2,null],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"new","","Constructs a new Config structure with the given options set.",2,{"inputs":[{"name":"bool"},{"name":"bool"},{"name":"bool"}],"output":{"name":"config"}}],[11,"default","","Constructs a new Config structure with default options set.",2,{"inputs":[],"output":{"name":"self"}}],[11,"fmt","","",9,null],[11,"from","","",9,{"inputs":[{"name":"ioerror"}],"output":{"name":"error"}}],[11,"from","","",9,{"inputs":[{"name":"fromutf8error"}],"output":{"name":"error"}}],[11,"from","","",9,{"inputs":[{"name":"fromutf16error"}],"output":{"name":"error"}}],[11,"from","","",9,{"inputs":[{"name":"ziperror"}],"output":{"name":"error"}}],[11,"from","","",9,{"inputs":[{"name":"encodererror"}],"output":{"name":"error"}}],[11,"description","","",9,null],[11,"cause","","",9,null],[11,"fmt","","",9,null],[11,"encode","","",3,null],[11,"fmt","","",3,null],[11,"new","","Constructs a new Item with an empty ID and the given ItemType.",3,{"inputs":[{"name":"itemtype"}],"output":{"name":"item"}}],[11,"with_split_id","","Constructs a new Item by combining the give u32 primary and secondary IDs into a single\nunique u64 ID, and passing through the given ItemType.",3,{"inputs":[{"name":"u32"},{"name":"u32"},{"name":"itemtype"}],"output":{"name":"item"}}],[11,"with_whole_id","","Constructs a new Item with the given ID and ItemType. This function simply passes through\nthe given ID to the Item without any transformation.",3,{"inputs":[{"name":"u64"},{"name":"itemtype"}],"output":{"name":"item"}}],[11,"update_id","","Combines u32 primary and secondary IDs into a single unique u64 ID by shifting the primary\nID 32 bits to the left and then adding the two IDs together.",3,null],[11,"encode","","",4,null],[11,"fmt","","",4,null],[11,"new","","Constructs a new Map with empty initial data.",4,{"inputs":[],"output":{"name":"map"}}],[11,"with_data","","Constructs a new Map initialized with the data given.",4,{"inputs":[{"name":"string"},{"name":"string"},{"name":"string"},{"name":"string"},{"name":"u32"},{"name":"u32"},{"name":"u32"}],"output":{"name":"map"}}],[11,"display","","Writes the contents of the Map to stdout.",4,null],[11,"encode","","",5,null],[11,"fmt","","",5,null],[11,"new","","Constructs a new Player with empty initial data.",5,{"inputs":[{"name":"u8"}],"output":{"name":"player"}}],[11,"display","","Writes the contents of the Player to stdout.",5,null],[11,"encode","","",6,null],[11,"fmt","","",6,null],[11,"new","","Constructs a new Replay and loads the file specified by path into memory.",6,{"inputs":[{"name":"path"},{"name":"config"}],"output":{"name":"result"}}],[11,"new_with_error","","Constructs a junk Replay type with empty data and an error value set. Used to return a\nReplay and its error information out of a thread without panicking if an error was\nencountered during creation.",6,{"inputs":[{"name":"str"},{"name":"error"}],"output":{"name":"replay"}}],[11,"from_bytes","","Constructs a new Replay and loads the byte vector given as the file data.",6,{"inputs":[{"name":"str"},{"name":"vec"},{"name":"config"}],"output":{"name":"result"}}],[11,"parse","","Parses the loaded replay and populates the Replay type with the return data.",6,null],[11,"to_json","","Serializes Replay as JSON String.",6,null],[11,"display","","Writes the contents of the Replay to stdout.",6,null],[6,"Result","","Custom Result wrapper for vault, used to return vault::Error from every result.",null,null],[11,"encode","","",7,null],[11,"fmt","","",7,null],[11,"parse","","Attempts to parse the given file, returning a Vault type populated with the Replay(s) if\nsuccessful.",7,{"inputs":[{"name":"path"}],"output":{"name":"result"}}],[11,"parse_with_config","","Functions the same as `parse`, but lets you specify non-default configuration options.",7,{"inputs":[{"name":"path"},{"name":"config"}],"output":{"name":"result"}}],[11,"to_json","","Serializes Vault as JSON String.",7,null]],"paths":[[3,"ChatLine"],[3,"Command"],[3,"Config"],[3,"Item"],[3,"Map"],[3,"Player"],[3,"Replay"],[3,"Vault"],[4,"CmdType"],[4,"Error"]]};
initSearch(searchIndex);