Struct ironworks::ffxiv::FsResource

pub struct FsResource { /* private fields */ }

Available on crate feature ffxiv only.

Resource adapter pre-configured to work with on-disk sqpack packages laid out in the FFXIV format.

Implementations

impl FsResource

pub fn search() -> Option<Self>

Search for a FFXIV install in common locations, configuring a resource instance with the found install, if any.

pub fn at(path: &Path) -> Self

Configure a resource instance with an installation of FFXIV at the specified path.

Trait Implementations

impl Debug for FsResource

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

Formats the value using the given formatter.

impl Resource for FsResource

Available on crate feature sqpack only.

fn path_metadata(&self, path: &str) -> Option<(u8, u8)>

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.

fn version(&self, repository: u8) -> Result<String, Error>

Get the version string for a given repository.

type Index = Cursor<Vec<u8, Global>>

The type of an index resource.

fn index(
    &self,
    repository: u8,
    category: u8,
    chunk: u8
) -> Result<Self::Index, Error>

Fetches the specified index resource.

type Index2 = Cursor<Vec<u8, Global>>

The type of an index2 resource.

fn index2(
    &self,
    repository: u8,
    category: u8,
    chunk: u8
) -> Result<Self::Index2, Error>

Fetches the specified index2 resource.

type Dat = File

The type of a dat resource.

fn dat(
    &self,
    repository: u8,
    category: u8,
    chunk: u8,
    dat: u8
) -> Result<Self::Dat, Error>

Fetches the specified dat resource.