### Search for FFXIV Install Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Searches common locations for an FFXIV installation and configures a resource instance if found. Returns an Option. ```rust pub fn search() -> Option ``` -------------------------------- ### FsResource::at Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Configures a resource instance with an FFXIV installation at a specified path. ```APIDOC ## pub fn at(path: &Path) -> Self ### Description Configure a resource instance with an installation of FFXIV at the specified path. ### Parameters #### Path Parameters - **path** (`&Path`) - Required - The path to the FFXIV installation directory. ### Returns A `Self` (FsResource) instance configured for the given path. ``` -------------------------------- ### FsResource::search Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Searches for a FFXIV install in common locations and configures a resource instance. ```APIDOC ## pub fn search() -> Option ### Description Search for a FFXIV install in common locations, configuring a resource instance with the found install, if any. ### Returns An `Option` which is `Some(FsResource)` if an installation is found, otherwise `None`. ``` -------------------------------- ### FsResource::version Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Gets the version string for a given repository. ```APIDOC ## fn version(&self, repository: u8) -> Result ### Description Get the version string for a given repository. ### Parameters #### Path Parameters - **repository** (`u8`) - Required - The repository identifier. ### Returns A `Result` containing the version string on success, or an `Error` if the version cannot be retrieved. ``` -------------------------------- ### Get Repository Version Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Retrieves the version string for a specified repository. Returns a Result. ```rust fn version(&self, repository: u8) -> Result ``` -------------------------------- ### version Method - Resource Trait Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/trait.Resource.html Gets the version string for a specified repository. Returns an Error if the version cannot be retrieved. ```rust fn version(&self, repository: u8) -> Result; ``` -------------------------------- ### Configure FsResource at Specific Path Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Configures a resource instance with an FFXIV installation located at the specified path. Returns a Self instance. ```rust pub fn at(path: &Path) -> Self ``` -------------------------------- ### SqPack::version - Get File Version Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Retrieves the version string for a specified file path within the SqPack structure. ```rust pub fn version(&self, path: &str) -> Result ``` -------------------------------- ### set Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Get metadata for for specified set ID. ```APIDOC ### impl EquipmentDeformerParameter #### pub fn set(&self, id: u16) -> Set Get metadata for for specified set ID. ``` -------------------------------- ### Initialize Ironworks Source: https://docs.rs/ironworks/0.4.1/ironworks/struct.Ironworks.html Creates a new instance of the Ironworks struct. This is the starting point for managing file resources. ```rust pub struct Ironworks { /* private fields */ } ``` -------------------------------- ### Get Channel Count Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.Format.html Returns the number of channels or components in the texture format. ```rust pub fn components(&self) -> u8 ``` -------------------------------- ### Get Texture Format Kind Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.Format.html Returns the general kind of the texture format (e.g., color, depth). ```rust pub fn kind(&self) -> FormatKind ``` -------------------------------- ### Mapper::exd() - Fetch Sheet Page Path Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Fetches the path to a sheet page file, specifying the sheet, start ID, and language ID. This method requires the 'excel' crate feature to be enabled. ```rust fn exd(&self, sheet: &str, start_id: u32, language_id: u8) -> String ``` -------------------------------- ### Sheet::kind Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Sheet.html Get the kind of this sheet. Available on crate feature `excel` only. ```APIDOC ## Sheet::kind ### Description Get the kind of this sheet. ### Method `kind(&self) -> Result` ### Parameters None ### Returns `Result`: The kind of the sheet or an error if it cannot be determined. ``` -------------------------------- ### Get Material Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Retrieves the version of the material structure. This is a method on the Material struct. ```rust pub fn version(&self) -> u32 ``` -------------------------------- ### Mapper::exd Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Fetches the file path for a specific sheet page file, including language and start ID. ```APIDOC ## Mapper::exd ### Description Fetch the path to a sheet page file. ### Method `fn exd(&self, sheet: &str, start_id: u32, language_id: u8) -> String` ### Parameters #### Path Parameters - **sheet** (str) - Required - The name of the sheet. - **start_id** (u32) - Required - The starting ID for the sheet page. - **language_id** (u8) - Required - The ID of the language. ### Available on `crate feature`excel` only.` ``` -------------------------------- ### Get Material Samplers Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Retrieves the texture samplers used by the material. This is a method on the Material struct. ```rust pub fn samplers(&self) -> &[Sampler] ``` -------------------------------- ### Get Excel Database Version Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Excel.html Retrieves the version string of the Excel database. This operation may return an error if the version cannot be determined. ```rust pub fn version(&self) -> Result ``` -------------------------------- ### Get Sampler Texture Path Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Sampler.html Retrieves the path to the texture used by this sampler. The path is not guaranteed to be absolute. ```rust pub fn texture(&self) -> String ``` -------------------------------- ### Get SqPack Path Metadata Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Retrieves the (repository, category) for a given SqPack path. Returns None if the path is invalid or malformed. ```rust fn path_metadata(&self, path: &str) -> Option<(u8, u8)> ``` -------------------------------- ### Build Excel Database with Options Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Excel.html Initializes an Excel database with additional configuration options. This method returns an ExcelOptions struct, allowing for customization before the database is fully built. ```rust pub fn with() -> ExcelOptions ``` -------------------------------- ### Get Texture Dimension Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the dimension kind of the texture. ```rust pub fn dimension(&self) -> Dimension ``` -------------------------------- ### Get Texture Height Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the height of the texture in pixels. ```rust pub fn height(&self) -> u16 ``` -------------------------------- ### build Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Build the configured Excel database. ```APIDOC ### impl<'i> ExcelOptions #### pub fn build( &self, ironworks: impl Into>, mapper: impl Mapper + 'static, ) -> Excel<'i> Build the configured Excel database. ``` -------------------------------- ### Get Texture Width Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the width of the texture in pixels. ```rust pub fn width(&self) -> u16 ``` -------------------------------- ### Get Page Definitions - ExcelHeader Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ExcelHeader.html Retrieves the definitions of pages containing data for the Excel sheet. This is part of the ExcelHeader struct. ```rust pub fn pages(&self) -> &Vec ``` -------------------------------- ### Build Excel Database with Options Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Constructs an Excel database using the configured ExcelOptions. Requires an Ironworks instance and a custom mapper. ```rust pub fn build( &self, ironworks: impl Into>, mapper: impl Mapper + 'static, ) -> Excel<'i> ``` -------------------------------- ### Get Texture Format Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the pixel data format of the texture. ```rust pub fn format(&self) -> Format ``` -------------------------------- ### Mapper::new Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Creates a new instance of the Mapper, pre-configured for FFXIV file locations. ```APIDOC ## Mapper::new ### Description Creates a new mapper pre-configured for FFXIV file locations. ### Method `pub fn new() -> Self` ``` -------------------------------- ### Get Sampler ID Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Sampler.html Retrieves the unique identifier for the texture sampler. ```rust pub fn id(&self) -> u32 ``` -------------------------------- ### Excel::new Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Excel.html Builds an Excel database. This function is available when the `excel` feature is enabled. ```APIDOC ## new ### Description Build an Excel database. ### Method `pub fn new(ironworks: impl Into>, mapper: impl Mapper + 'static) -> Self` ### Parameters * `ironworks`: An object that can be converted into `Borrowed<'i, Ironworks>`. * `mapper`: An object implementing the `Mapper` trait with a `'static` lifetime. ``` -------------------------------- ### Get Skeleton File Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Retrieves the version of the skeleton file. This is a XIV-specific tag and may not correlate with the embedded tagfile version. ```rust pub fn version(&self) -> Version ``` -------------------------------- ### Material::read Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Builds an instance of the Material file from its raw byte representation. ```APIDOC ## fn read<'a>(data: impl Into>) -> Result Build an instance of this file from the raw byte representation. ``` -------------------------------- ### Implement ToString for T Source: https://docs.rs/ironworks/0.4.1/ironworks/enum.Error.html Converts any type that implements the Display trait into a String. This is a common way to get a string representation of a value. ```rust impl ToString for T where T: Display + ?Sized, { fn to_string(&self) -> String } ``` -------------------------------- ### ExcelOptions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Options for the root Excel database. Available on crate feature `excel` only. ```APIDOC ## Struct ExcelOptions Available on **crate feature `excel`** only. Options for the root Excel database. ``` -------------------------------- ### Get Texture Mip Levels Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the count of mipmap levels for the texture. ```rust pub fn mip_levels(&self) -> u16 ``` -------------------------------- ### Excel::with Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Excel.html Builds an Excel database with additional options. This function is available when the `excel` feature is enabled. ```APIDOC ## with ### Description Build an Excel database with additional options. ### Method `pub fn with() -> ExcelOptions` ### Returns An `ExcelOptions` struct to configure the database creation. ``` -------------------------------- ### Get Texture Depth Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the depth of the texture. The interpretation of this value is unknown. ```rust pub fn depth(&self) -> u16 ``` -------------------------------- ### Read File with Specific Type Source: https://docs.rs/ironworks/0.4.1/ironworks/struct.Ironworks.html Reads a file at the given path and parses it into the specified file type `F`. Use `Vec` to get raw bytes. ```rust pub fn file(&self, path: &str) -> Result ``` -------------------------------- ### Resource::version Method Source: https://docs.rs/ironworks/0.4.1/ironworks/trait.Resource.html Retrieves the version string for a file at the specified path. Returns Err(Error::NotFound) if the file is not found, allowing lookups to continue. ```rust fn version(&self, path: &str) -> Result ``` -------------------------------- ### Get Character ID Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Retrieves the unique identifier for the character associated with this skeleton. ```rust pub fn character_id(&self) -> u32 ``` -------------------------------- ### SqPack::version Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Get the version string for the file at `path`. This method is available on the SqPack struct and also implemented via the Resource trait. ```APIDOC ## version(&self, path: &str) -> Result ### Description Get the version string for the file at `path`. ### Method `version` ### Parameters * `path` (str): The path to the file within the SqPack package. ### Returns * `Result`: A Result containing the version string if successful, or an Error if the file is not found or another issue occurs. ``` -------------------------------- ### SqPack::new Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Builds a representation of SqPack packages. The provided resource will be queried for lookups as required to fulfil SqPack requests. ```APIDOC ## new(resource: R) -> Self ### Description Build a representation of SqPack packages. The provided resource will be queried for lookups as required to fulfil SqPack requests. ### Method `new` ### Parameters * `resource` (R): The resource to use for querying SqPack packages. ``` -------------------------------- ### Resource::file Method Source: https://docs.rs/ironworks/0.4.1/ironworks/trait.Resource.html Fetches the raw byte data for a file at the specified path. Returns Err(Error::NotFound) if the file is not found, allowing lookups to continue. ```rust fn file(&self, path: &str) -> Result, Error> ``` -------------------------------- ### Get Meshes from Model Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.Model.html Retrieves a vector containing all meshes that are part of this model. Ensure the 'mdl' feature is enabled to use this functionality. ```rust pub fn meshes(&self) -> Vec ``` -------------------------------- ### Fetch Excel Sheet Page File Path Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/trait.Mapper.html Retrieves the file path for a specific page within an Excel sheet. Requires the sheet name, start ID, and language ID. This method is part of the Mapper trait. ```rust fn exd(&self, sheet: &str, start_id: u32, language_id: u8) -> String; ``` -------------------------------- ### ExcelList::read Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exl/struct.ExcelList.html Builds an ExcelList instance from raw byte data. ```APIDOC ## ExcelList::read ### Description Build an instance of this file from the raw byte representation. ### Method `read` ### Parameters * `data` - `impl Into>` - The raw byte data to read from. ### Returns `Result` - An `Ok` containing the `ExcelList` instance on success, or an `Err` containing an `Error` on failure. ``` -------------------------------- ### Get Connected Bones Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Retrieves a vector of i16 values representing the connected bones. ```rust pub fn connect_bones(&self) -> Vec ``` -------------------------------- ### Get Texture Pixel Data Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Retrieves the byte array of pixel data for the texture. ```rust pub fn data(&self) -> &Vec ``` -------------------------------- ### Get Deformer's Bone Matrices Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Deformer.html Retrieves the bone matrices for this deformer, if they exist. Returns an Option containing a HashMap where keys are bone names (String) and values are 3x4 matrices (arrays of 4 arrays of 3 f32). ```rust pub fn bone_matrices(&self) -> Option<&HashMap> ``` -------------------------------- ### Get Layer Value - AnimationLayer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.AnimationLayer.html Retrieves the layer value as a u32 from an AnimationLayer instance. ```rust pub fn layer(&self) -> u32 ``` -------------------------------- ### Default Implementation for ExcelOptions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Provides a default configuration for ExcelOptions, allowing for easy initialization. ```rust fn default() -> ExcelOptions ``` -------------------------------- ### Get Column Kind - ColumnDefinition Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ColumnDefinition.html Retrieves the data type stored within this column. ```rust pub fn kind(&self) -> ColumnKind ``` -------------------------------- ### Mapper::exl() - Fetch Excel List Path Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Fetches the path to the excel list file. This method requires the 'excel' crate feature to be enabled. ```rust fn exl(&self) -> String ``` -------------------------------- ### Get Bone Indices - AnimationLayer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.AnimationLayer.html Retrieves a reference to the vector of bone indices from an AnimationLayer instance. ```rust pub fn bone_indices(&self) -> &Vec ``` -------------------------------- ### File Implementation for EquipmentDeformerParameter Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Enables building an instance of EquipmentDeformerParameter from raw byte data. ```rust fn read<'a>(data: impl Into>) -> Result ``` -------------------------------- ### Implement CloneToUninit for T (Nightly) Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html A nightly-only experimental API that performs copy-assignment from self to an uninitialized destination. Requires T to implement Clone. ```rust unsafe impl CloneToUninit for T { fn clone_to_uninit(&self, dest: *mut u8) { // ... implementation details ... unimplemented!() } } ``` -------------------------------- ### Get Model by LOD - ModelContainer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.ModelContainer.html Retrieves the model for a specified Level of Detail (Lod) from the ModelContainer. ```rust pub fn model(&self, level: Lod) -> Model ``` -------------------------------- ### path_metadata Method - Resource Trait Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/trait.Resource.html Retrieves the repository and category for a given SqPack path. Returns None if the path is invalid. ```rust fn path_metadata(&self, path: &str) -> Option<(u8, u8)>; ``` -------------------------------- ### Generic Implementations for EquipmentDeformerParameter Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Shows various blanket implementations for traits like Any, Borrow, BorrowMut, From, Into, TryFrom, and TryInto, demonstrating generic capabilities. ```rust fn type_id(&self) -> TypeId ``` ```rust fn borrow(&self) -> &T ``` ```rust fn borrow_mut(&mut self) -> &mut T ``` ```rust fn from(t: T) -> T ``` ```rust fn into(self) -> U where U: From, ``` ```rust type Error = Infallible; fn try_from(value: U) -> Result>::Error> ``` ```rust type Error = >::Error; fn try_into(self) -> Result>::Error> ``` -------------------------------- ### Get Mapper Character ID Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Retrieves the mapper character ID, which is an array of four u32 values. ```rust pub fn mapper_character_id(&self) -> [u32; 4] ``` -------------------------------- ### Sheet::with Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Sheet.html Create a row options builder for this sheet. Available on crate feature `excel` only. ```APIDOC ## Sheet::with ### Description Create a row options builder for this sheet. ### Method `with(&'i self) -> RowOptions<'i, S>` ### Parameters None ### Returns `RowOptions<'i, S>`: A builder for row options. ``` -------------------------------- ### Set Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.Set.html These methods allow access to the metadata for each equipment slot within a Set. ```APIDOC ## Set Methods ### head Metadata for the head slot. ### body Metadata for the body slot. ### hands Metadata for the hands slot. ### legs Metadata for the legs slot. ### feet Metadata for the feet slot. ### ears Metadata for the ears slot. ### neck Metadata for the neck slot. ### wrists Metadata for the wrists slot. ### ring_right Metadata for the right ring slot. ### ring_left Metadata for the left ring slot. ``` -------------------------------- ### Sampler Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Sampler.html Provides methods to interact with the Sampler struct, such as retrieving its ID and texture path. ```APIDOC ## pub fn id(&self) -> u32 ### Description Sampler ID. ### Method `id` ### Parameters None ### Returns - `u32`: The sampler ID. ``` ```APIDOC ## pub fn texture(&self) -> String ### Description Path to the texture used by this sampler. Path is not guaranteed to be absolute. ### Method `texture` ### Parameters None ### Returns - `String`: The path to the texture. ``` -------------------------------- ### Get Bits Per Pixel Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.Format.html Returns the total number of bits used per pixel for the texture format. ```rust pub fn bits_per_pixel(&self) -> u8 ``` -------------------------------- ### Create Row Options Builder Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Sheet.html Initializes a row options builder for the current sheet. This is used to configure options before fetching rows. ```rust pub fn with(&'i self) -> RowOptions<'i, S> ``` -------------------------------- ### Texture Implementations Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/struct.Texture.html Details on how Texture can be read and parsed. ```APIDOC ## Texture Implementations ### `impl BinRead for Texture` Provides methods for reading `Texture` data from a source. - **`read_options`**: Reads `Self` from the reader using `ReadOptions` and arguments. - **`read`**: Reads `Self` from the reader using default arguments. - **`read_args`**: Reads `Self` from the reader using the given arguments. - **`after_parse`**: Runs post-processing steps to finalize object construction. ### `impl File for Texture` Provides a method for building `Texture` from raw byte data. - **`read`**: Builds an instance of `Texture` from raw byte representation. ``` -------------------------------- ### Get Deformer's Node Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Deformer.html Retrieves the corresponding node in the tree for this deformer. This method is part of the Deformer implementation. ```rust pub fn node(&self) -> Node<'_> ``` -------------------------------- ### Get Column Offset - ColumnDefinition Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ColumnDefinition.html Retrieves the byte offset of this column within the row's structured data. ```rust pub fn offset(&self) -> u16 ``` -------------------------------- ### Fetch All Column Definitions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Sheet.html Fetches metadata for all columns within the sheet. The result is a Vec of ColumnDefinition, or an Error if the operation fails. ```rust pub fn columns(&self) -> Result, Error> ``` -------------------------------- ### Get Subrow ID Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Row.html Retrieves the subrow identifier for this row. This method is part of the Row struct's implementation. ```rust pub fn subrow_id(&self) -> &u16 ``` -------------------------------- ### SqPack::new - Build SqPack Representation Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Constructs a SqPack representation using a provided resource. The resource is queried for lookups to fulfill SqPack requests. ```rust pub fn new(resource: R) -> Self ``` -------------------------------- ### Get Row ID Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Row.html Retrieves the unique identifier for this row. This method is part of the Row struct's implementation. ```rust pub fn row_id(&self) -> &u32 ``` -------------------------------- ### Build Excel Database Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Excel.html Constructs a new Excel database instance. It requires an Ironworks instance and a Mapper implementation. This function is part of the Excel struct's implementation. ```rust pub fn new( ironworks: impl Into>, mapper: impl Mapper + 'static, ) -> Self ``` -------------------------------- ### Get Equipment Set Metadata Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Retrieves metadata for a specified set ID. This method is part of the EquipmentDeformerParameter struct. ```rust pub fn set(&self, id: u16) -> Set ``` -------------------------------- ### Mapper::exl Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Fetches the file path for the Excel list file. ```APIDOC ## Mapper::exl ### Description Fetch the path to the excel list file. ### Method `fn exl(&self) -> String` ### Available on `crate feature`excel` only.` ``` -------------------------------- ### CloneToUninit Trait Implementation (Nightly) Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/enum.SheetKind.html Experimental nightly feature for cloning data to uninitialized memory. ```rust unsafe fn clone_to_uninit(&self, dest: *mut u8) ``` -------------------------------- ### Default Implementation for RowOptions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.RowOptions.html Provides a default configuration for RowOptions, allowing it to be created without explicit parameters. ```rust fn default() -> Self ``` -------------------------------- ### Get Deformers Iterator - PreBoneDeformer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.PreBoneDeformer.html Retrieves an iterator over the deformers contained within the PreBoneDeformer. This method is part of the PreBoneDeformer implementation. ```rust pub fn deformers(&self) -> impl Iterator> ``` -------------------------------- ### Format Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.Format.html Methods available on the Format enum. ```APIDOC ## impl Format ### pub fn kind(&self) -> FormatKind Texture format kind. ### pub fn components(&self) -> u8 Channel or component count. ### pub fn bits_per_pixel(&self) -> u8 Bits per pixel. ``` -------------------------------- ### Get Material Shader Name Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Retrieves the name of the shader file or package used by this material. This is a method on the Material struct. ```rust pub fn shader(&self) -> &str ``` -------------------------------- ### BinRead Implementation for EquipmentDeformerParameter Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Provides methods for reading EquipmentDeformerParameter from binary data. Includes implementations for read_options, read, and read_args. ```rust type Args = (); fn read_options( __binrw_generated_var_reader: &mut R, __binrw_generated_var_options: &ReadOptions, __binrw_generated_var_arguments: Self::Args, ) -> BinResult ``` ```rust fn read(reader: &mut R) -> Result where R: Read + Seek, Self::Args: Default, ``` ```rust fn read_args(reader: &mut R, args: Self::Args) -> Result where R: Read + Seek, ``` ```rust fn after_parse( &mut self, _: &mut R, _: &ReadOptions, _: Self::Args, ) -> Result<(), Error> where R: Read + Seek, ``` -------------------------------- ### Get Deformer's Character ID Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Deformer.html Retrieves the character ID that this deformer represents. This method is part of the Deformer implementation. ```rust pub fn id(&self) -> u16 ``` -------------------------------- ### Get Node's Deformer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Node.html Retrieves the Deformer associated with this node. This method is part of the Node struct's implementation. ```rust pub fn deformer(&self) -> Deformer<'_> ``` -------------------------------- ### File for EquipmentDeformerParameter Source: https://docs.rs/ironworks/0.4.1/ironworks/file/eqdp/struct.EquipmentDeformerParameter.html Implementation for the File trait, allowing EquipmentDeformerParameter to be built from raw byte data. ```APIDOC ### impl File for EquipmentDeformerParameter #### fn read<'a>(data: impl Into>) -> Result Build an instance of this file from the raw byte representation. ``` -------------------------------- ### FsResource::path_metadata Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Retrieves the repository and category for a given SqPack path. ```APIDOC ## fn path_metadata(&self, path: &str) -> Option<(u8, u8)> ### Description Retrieve the `(repository, category)` for a given SqPack path, or `None` if the path is invalid or does not conform to valid formatting for this resource. ### Parameters #### Path Parameters - **path** (`&str`) - Required - The SqPack path to query. ### Returns An `Option<(u8, u8)>` containing the repository and category if the path is valid, otherwise `None`. ``` -------------------------------- ### Get Row Size - ExcelHeader Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ExcelHeader.html Returns the size of structured data in each row, measured in bytes. This is part of the ExcelHeader struct. ```rust pub fn row_size(&self) -> u16 ``` -------------------------------- ### Get Supported Language IDs - ExcelHeader Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ExcelHeader.html Retrieves the language IDs supported by the Excel sheet. This is part of the ExcelHeader struct. ```rust pub fn languages(&self) -> &HashSet ``` -------------------------------- ### Define ExcelOptions Struct Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Defines the structure for Excel database options. This struct is only available when the 'excel' feature is enabled. ```rust pub struct ExcelOptions { /* private fields */ } ``` -------------------------------- ### Get Column Definitions - ExcelHeader Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ExcelHeader.html Retrieves the column definitions for rows within the Excel sheet. This is part of the ExcelHeader struct. ```rust pub fn columns(&self) -> &Vec ``` -------------------------------- ### Fetch Index Resource Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Fetches the specified index resource for a given repository, category, and chunk. Returns a Result. ```rust fn index( &self, repository: u8, category: u8, chunk: u8, ) -> Result ``` -------------------------------- ### Get Row Count of PageDefinition Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.PageDefinition.html Retrieves the number of rows contained within the page. This method is part of the PageDefinition struct. ```rust pub fn row_count(&self) -> u32 ``` -------------------------------- ### Ironworks::new Source: https://docs.rs/ironworks/0.4.1/ironworks/struct.Ironworks.html Constructs a new, empty instance of the Ironworks struct. ```APIDOC ## Ironworks::new ### Description Build a new instance of ironworks. ### Method ```rust pub fn new() -> Self ``` ``` -------------------------------- ### SkeletonBinary Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Provides access to various components and metadata of the skeleton data. ```APIDOC ## SkeletonBinary Skeleton data and related mappings. ### Available on crate feature `sklb` only. ### Methods #### `animation_layers(&self) -> &Vec` Returns the animation layers associated with the skeleton. #### `skeleton(&self) -> &Vec` Returns the skeleton data in Havok binary tagfile format. #### `version(&self) -> Version` Returns the version of this skeleton file. This is a XIV-specific version tag. #### `character_id(&self) -> u32` Returns the ID of the character associated with this skeleton. #### `mapper_character_id(&self) -> [u32; 4]` Returns the mapper character ID. #### `connect_bones(&self) -> Vec` Returns the bone connection data. #### `lod_sample_bone_count(&self) -> Option<[i16; 3]>` Returns the bone count for each Level of Detail (LOD) sample, if available. ``` -------------------------------- ### Get First ID of PageDefinition Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.PageDefinition.html Retrieves the first ID contained within the page. This method is part of the PageDefinition struct. ```rust pub fn start_id(&self) -> u32 ``` -------------------------------- ### Material::version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Retrieves the version of the material structure. ```APIDOC ## pub fn version(&self) -> u32 Version of the material structure. ``` -------------------------------- ### Mapper::exh() - Fetch Sheet Header Path Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.Mapper.html Fetches the path to a sheet header file. This method requires the 'excel' crate feature to be enabled. ```rust fn exh(&self, sheet: &str) -> String ``` -------------------------------- ### Get Sheet Kind Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.Sheet.html Retrieves the kind of the sheet. This method returns a Result, indicating success with a SheetKind or failure with an Error. ```rust pub fn kind(&self) -> Result ``` -------------------------------- ### Fetch Dat Resource Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Fetches the specified dat resource for a given repository, category, chunk, and dat file. Returns a Result. ```rust fn dat( &self, repository: u8, category: u8, chunk: u8, dat: u8, ) -> Result ``` -------------------------------- ### Try Convert From Another Type Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.Format.html Attempts to convert another type U into a Format enum value. Requires U to implement `Into`. ```rust type Error = Infallible; fn try_from(value: U) -> Result>::Error> where U: Into, ``` -------------------------------- ### Get Node's Parent Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Node.html Retrieves the parent node of the current node, if it exists. Returns None if the node is the root of the tree. ```rust pub fn parent(&self) -> Option> ``` -------------------------------- ### TryFrom for FormatKind Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.FormatKind.html Allows conversion from a u32 primitive to a FormatKind enum. ```APIDOC ### impl TryFrom for FormatKind #### fn try_from(number: u32) -> Result> Performs the conversion from a u32 to a FormatKind. Returns an error if the number does not correspond to a valid FormatKind variant. ``` -------------------------------- ### Get Mesh Vertex Attributes Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.Mesh.html Retrieves the vertex attributes for all vertices in the mesh. Returns a Result containing a Vec of VertexAttribute or an Error. ```rust pub fn attributes(&self) -> Result, Error> ``` -------------------------------- ### ModelContainer::read Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.ModelContainer.html Builds an instance of ModelContainer from its raw byte representation. ```APIDOC ## ModelContainer::read ### Description Build an instance of this file from the raw byte representation. ### Method `read` ### Parameters #### Request Body - **data** (impl Into>) - Required - The raw byte data to parse. ### Response #### Success Response (Result) - Returns `Ok(Self)` on successful parsing, or `Err(Error)` if parsing fails. ``` -------------------------------- ### TryFrom for FormatKind Source: https://docs.rs/ironworks/0.4.1/ironworks/file/tex/enum.FormatKind.html Performs the conversion from a u32 primitive to a FormatKind. The conversion can fail if the number does not correspond to a valid FormatKind variant. ```rust type Error = TryFromPrimitiveError; fn try_from(number: u32) -> Result> { // ... implementation details ... } ``` -------------------------------- ### Get Mesh Material Path Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.Mesh.html Retrieves the path to the material associated with this mesh. Returns a Result containing the String path or an Error. ```rust pub fn material(&self) -> Result ``` -------------------------------- ### SkeletonBinary File Reading Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Methods for reading SkeletonBinary data from various sources. ```APIDOC ## SkeletonBinary File Reading ### `impl File for SkeletonBinary` #### `read<'a>(data: impl Into>) -> Result` Build an instance of this file from the raw byte representation. ``` -------------------------------- ### Implement Any for T Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Provides runtime type information for any type T, enabling dynamic type checks and downcasting. ```rust impl Any for T { fn type_id(&self) -> TypeId { // ... implementation details ... unimplemented!() } } ``` -------------------------------- ### SkeletonBinary BinRead Implementation Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Provides methods for reading SkeletonBinary using the `BinRead` trait. ```APIDOC ## SkeletonBinary BinRead Implementation ### `impl BinRead for SkeletonBinary` #### `type Args = ()` The type used for the `args` parameter of `read_args()` and `read_options()`. #### `fn read_options( __binrw_generated_var_reader: &mut R, __binrw_generated_var_options: &ReadOptions, __binrw_generated_var_arguments: Self::Args, ) -> BinResult` Read `Self` from the reader using the given `ReadOptions` and arguments. #### `fn read(reader: &mut R) -> Result` where R: Read + Seek, Self::Args: Default, Read `Self` from the reader using default arguments. #### `fn read_args(reader: &mut R, args: Self::Args) -> Result` where R: Read + Seek, Read `Self` from the reader using the given arguments. #### `fn after_parse( &mut self, _: &mut R, _: &ReadOptions, _: Self::Args, ) -> Result<(), Error>` where R: Read + Seek, Runs any post-processing steps required to finalize construction of the object. ``` -------------------------------- ### Get Root Node - PreBoneDeformer Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.PreBoneDeformer.html Retrieves the root node of the PreBoneDeformer's node tree, if it exists. This method is part of the PreBoneDeformer implementation. ```rust pub fn root_node(&self) -> Option> ``` -------------------------------- ### impl BinRead for SeString Source: https://docs.rs/ironworks/0.4.1/ironworks/sestring/struct.SeString.html Provides methods for reading SeString data from a binary reader with options and arguments. ```APIDOC ### impl BinRead for SeString #### fn read_options( __binrw_generated_var_reader: &mut R, __binrw_generated_var_options: &ReadOptions, __binrw_generated_var_arguments: Self::Args, ) -> BinResult Read `Self` from the reader using the given `ReadOptions` and arguments. #### fn read(reader: &mut R) -> Result where R: Read + Seek, Self::Args: Default, Read `Self` from the reader using default arguments. #### fn read_args(reader: &mut R, args: Self::Args) -> Result where R: Read + Seek, Read `Self` from the reader using the given arguments. #### fn after_parse( &mut self, _: &mut R, _: &ReadOptions, _: Self::Args, ) -> Result<(), Error> where R: Read + Seek, Runs any post-processing steps required to finalize construction of the object. ``` -------------------------------- ### Material Struct Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Represents a material with metadata for shaders and references to shader assets. ```APIDOC ## Struct Material Available on **crate feature `mtrl`** only. A material. Contains metadata to be used by shaders, and references to the shader and requisite assets used by the material. ```rust pub struct Material { /* private fields */ } ``` ``` -------------------------------- ### Get Node's Next Sibling Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Node.html Retrieves the next sibling node of the current node, if it exists. Returns None if this is the last sibling. ```rust pub fn next(&self) -> Option> ``` -------------------------------- ### SeString ToString Implementation Source: https://docs.rs/ironworks/0.4.1/ironworks/sestring/struct.SeString.html Enables conversion of SeString instances to a String representation. ```rust fn to_string(&self) -> String ``` -------------------------------- ### Get Node's First Child Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Node.html Retrieves the first child node of the current node, if it has any children. Returns None if the node has no children. ```rust pub fn first_child(&self) -> Option> ``` -------------------------------- ### Get Sheet Kind - ExcelHeader Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ExcelHeader.html Determines the kind of the relevant sheet, which dictates the binary layout and capabilities of rows. This is part of the ExcelHeader struct. ```rust pub fn kind(&self) -> SheetKind ``` -------------------------------- ### Fetch Index2 Resource Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Fetches the specified index2 resource for a given repository, category, and chunk. Returns a Result. ```rust fn index2( &self, repository: u8, category: u8, chunk: u8, ) -> Result ``` -------------------------------- ### Debug Implementation for ExcelOptions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Enables debugging capabilities for ExcelOptions, allowing the struct to be formatted for inspection. ```rust fn fmt(&self, f: &mut Formatter<'_>) -> Result ``` -------------------------------- ### Resource Trait Source: https://docs.rs/ironworks/0.4.1/ironworks/trait.Resource.html Defines the interface for resources that can provide data to an ironworks instance. It includes methods for getting file versions and raw file content. ```APIDOC ## Trait Resource ### Description Resource layer that can provide data to an ironworks instance. ### Methods #### fn version(&self, path: &str) -> Result Get the version string for the file at `path`. A return value of `Err(Error::NotFound(ErrorValue::Path(_)))` will result in lookups continuing to the next resource. #### fn file(&self, path: &str) -> Result, Error> Get the raw byte data for the file at `path`. A return value of `Err(Error::NotFound(ErrorValue::Path(_)))` will result in lookups continuing to the next resource. ``` -------------------------------- ### Get LOD Sample Bone Count Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/struct.SkeletonBinary.html Retrieves an optional array of three i16 values representing the bone count for Level of Detail (LOD) samples. ```rust pub fn lod_sample_bone_count(&self) -> Option<[i16; 3]> ``` -------------------------------- ### Implement BinRead for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Provides functionality to read the Version enum from a binary reader. Requires `Read + Seek` and uses default arguments for reading. ```rust impl BinRead for Version where for<'a> Self: ReadFrom, { type Args = (); fn read_options( __binrw_generated_var_reader: &mut R, __binrw_generated_var_options: &ReadOptions, __binrw_generated_var_arguments: Self::Args, ) -> BinResult { // ... implementation details ... unimplemented!() } fn read(reader: &mut R) -> Result { // ... implementation details ... unimplemented!() } fn read_args(reader: &mut R, args: Self::Args) -> Result { // ... implementation details ... unimplemented!() } fn after_parse( &mut self, _: &mut R, _: &ReadOptions, _: Self::Args, ) -> Result<(), Error> { // ... implementation details ... unimplemented!() } } ``` -------------------------------- ### Ironworks::file Source: https://docs.rs/ironworks/0.4.1/ironworks/struct.Ironworks.html Reads and parses a file at the given path using the specified file type `F`. Use `Vec` for `F` to get raw bytes. ```APIDOC ## Ironworks::file ### Description Read the file at `path`, using file type F to parse. To retrieve the file as raw bytes, pass `Vec` to F. ### Method ```rust pub fn file(&self, path: &str) -> Result ``` ``` -------------------------------- ### Implement Copy for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Indicates that the Version enum can be copied by simply copying its bits, as it is a simple type. ```rust impl Copy for Version {} ``` -------------------------------- ### Get Mesh Indices Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mdl/struct.Mesh.html Retrieves the indices of vertices within the mesh. Vertices are laid out in a triangle list topology. Returns a Result containing a Vec of u16 indices or an Error. ```rust pub fn indices(&self) -> Result, Error> ``` -------------------------------- ### Implement Clone for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Allows creating a duplicate of a Version enum value. Also includes `clone_from` for efficient copying. ```rust impl Clone for Version { fn clone(&self) -> Version { // ... implementation details ... unimplemented!() } fn clone_from(&mut self, source: &Self) { // ... implementation details ... unimplemented!() } } ``` -------------------------------- ### Material::samplers Source: https://docs.rs/ironworks/0.4.1/ironworks/file/mtrl/struct.Material.html Retrieves the texture samplers used by the material. ```APIDOC ## pub fn samplers(&self) -> &[Sampler] Texture samplers used by the material. ``` -------------------------------- ### PreBoneDeformer Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.PreBoneDeformer.html Provides methods to interact with the PreBoneDeformer struct, allowing access to its deformers and root node. ```APIDOC ## pub fn deformers(&self) -> impl Iterator> ### Description Get an iterator over the deformers in this file. ### Method `deformers` ### Parameters - `&self`: A reference to the `PreBoneDeformer` instance. ### Returns An iterator over `Deformer` items. ``` ```APIDOC ## pub fn root_node(&self) -> Option> ### Description Get the root of the node tree. ### Method `root_node` ### Parameters - `&self`: A reference to the `PreBoneDeformer` instance. ### Returns An `Option` containing the root `Node` if it exists, otherwise `None`. ``` -------------------------------- ### Clone Implementation for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Implementation of the `Clone` trait for the Version enum. ```APIDOC ### impl Clone for Version #### fn clone(&self) -> Version Returns a duplicate of the value. #### fn clone_from(&mut self, source: &Self) Performs copy-assignment from `source`. ``` -------------------------------- ### SqPack::file - Read File Content Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Reads the content of a file at the specified path from SqPack. Returns the file content as a byte vector. ```rust pub fn file(&self, path: &str) -> Result, Error> ``` -------------------------------- ### FsResource::dat Source: https://docs.rs/ironworks/0.4.1/ironworks/ffxiv/struct.FsResource.html Fetches the specified dat resource. ```APIDOC ## fn dat(&self, repository: u8, category: u8, chunk: u8, dat: u8) -> Result ### Description Fetches the specified dat resource. ### Parameters #### Path Parameters - **repository** (`u8`) - Required - The repository identifier. - **category** (`u8`) - Required - The category identifier. - **chunk** (`u8`) - Required - The chunk identifier. - **dat** (`u8`) - Required - The dat file identifier. ### Returns A `Result` containing the dat resource on success, or an `Error` if the dat resource cannot be fetched. ``` -------------------------------- ### Copy Implementation for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Implementation of the `Copy` trait for the Version enum. ```APIDOC ### impl Copy for Version ``` -------------------------------- ### SqPack::file Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/struct.SqPack.html Read the file at `path` from SqPack. This method is available on the SqPack struct and also implemented via the Resource trait. ```APIDOC ## file(&self, path: &str) -> Result, Error> ### Description Read the file at `path` from SqPack. ### Method `file` ### Parameters * `path` (str): The path to the file within the SqPack package. ### Returns * `Result, Error>`: A Result containing the file content as a byte vector if successful, or an Error if the file is not found or another issue occurs. ``` -------------------------------- ### index Method - Resource Trait Source: https://docs.rs/ironworks/0.4.1/ironworks/sqpack/trait.Resource.html Fetches the specified index resource for a given repository, category, and chunk. Returns an Error if the index cannot be fetched. ```rust fn index( &self, repository: u8, category: u8, chunk: u8, ) -> Result; ``` -------------------------------- ### ColumnDefinition Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/exh/struct.ColumnDefinition.html Methods available on the ColumnDefinition struct. ```APIDOC ## ColumnDefinition Metadata for a single sheet column. ### Methods #### `fn kind(&self) -> ColumnKind` The kind of data stored in this column. #### `fn offset(&self) -> u16` The offset of this column in bytes within the row structured data. ``` -------------------------------- ### Fetch Excel List File Path Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/trait.Mapper.html Retrieves the file path for the main Excel list file. This method is part of the Mapper trait. ```rust fn exl(&self) -> String; ``` -------------------------------- ### Deformer Methods Source: https://docs.rs/ironworks/0.4.1/ironworks/file/pbd/struct.Deformer.html This section details the methods available on the Deformer struct, allowing users to retrieve associated node information, the character ID, and bone matrices. ```APIDOC ## Deformer ### impl Deformer<'_> #### pub fn node(&self) -> Node<'_> Get this deformer’s corresponding node in the tree. #### pub fn id(&self) -> u16 Get the character ID this deformer represents. #### pub fn bone_matrices(&self) -> Option<&HashMap> Get the bone matrices for this deformer, if any exist. ``` -------------------------------- ### SheetMetadata Implementation for Strings Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/trait.SheetMetadata.html Provides a basic implementation of SheetMetadata for plain strings, useful when the sheet name is directly provided. This allows direct access to the row reader for manual field extraction. ```rust impl SheetMetadata for S type Row = Row; type Error = Infallible; ``` -------------------------------- ### Set Default Language for ExcelOptions Source: https://docs.rs/ironworks/0.4.1/ironworks/excel/struct.ExcelOptions.html Configures the default language for the Excel database. Accepts any type that can be converted into a u8. ```rust pub fn language(&mut self, language: impl Into) -> &mut Self ``` -------------------------------- ### Implement Debug for Version Source: https://docs.rs/ironworks/0.4.1/ironworks/file/sklb/enum.Version.html Enables the debugging representation of the Version enum, allowing it to be formatted for debugging output. ```rust impl Debug for Version { fn fmt(&self, f: &mut Formatter<'_>) -> Result { // ... implementation details ... unimplemented!() } } ```