Enum RawModuleLocation

pub enum RawModuleLocation {
    InstalledMods,
    Mods,
    Vanilla,
    Unknown,
    LegendsExport,
}

Standard location options for raw files in the DF Directory Raws are part of modules since 50.xx. Raw modules are loaded from 3 common locations: {df_directory}/data/vanilla, {df_directory}/mods, and {df_directory/data/installed_mods}

Variants

InstalledMods

The “installed” mods directory

Mods

The “downloaded” mods directory

Vanilla

The vanilla data file location

Unknown

An unknown location

LegendsExport

Used for handling legends exported files

Implementations

impl RawModuleLocation

pub fn get_path(self) -> PathBuf

Returns the path of the raw module location

Returns

• A PathBuf representing the path of the raw module location

pub fn from_path<P: AsRef<Path>>(path: &P) -> Self

Returns a RawModuleLocation from a path

Arguments

• df_directory - The path to the Dwarf Fortress directory

Returns

• A RawModuleLocation representing the path

pub fn from_sourced_directory(sourced_directory: &str) -> Self

Returns a RawModuleLocation from a sourced directory

Arguments

• sourced_directory - The sourced directory

Returns

• A RawModuleLocation representing the sourced directory

pub fn from_info_text_file_path<P: AsRef<Path>>(full_path: &P) -> Self

Returns a RawModuleLocation from an info.txt file path

Arguments

• full_path - The full path to the info.txt file

Returns

• A RawModuleLocation representing the info.txt file path

Trait Implementations

impl Clone for RawModuleLocation

fn clone(&self) -> RawModuleLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawModuleLocation

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

Formats the value using the given formatter.

impl Default for RawModuleLocation

fn default() -> RawModuleLocation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RawModuleLocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RawModuleLocation

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

Formats the value using the given formatter.

impl Hash for RawModuleLocation

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NamedType for RawModuleLocation

fn named_data_type( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<NamedDataType, ExportError>

this is equivalent to Type::inline but returns a NamedDataType instead. This is a compile-time guaranteed alternative to extracting the DataType::Named variant.

fn definition_named_data_type( opts: DefOpts<'_>, ) -> Result<NamedDataType, ExportError>

this is equivalent to Type::definition but returns a NamedDataType instead. This is a compile-time guaranteed alternative to extracting the DataType::Named variant.

impl PartialEq for RawModuleLocation

fn eq(&self, other: &RawModuleLocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RawModuleLocation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for RawModuleLocation

fn inline( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<DataType, ExportError>

Returns the inline definition of a type with generics substituted for those provided. This function defines the base structure of every type, and is used in both definition and reference

fn category_impl( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<TypeCategory, ExportError>

Defines which category this type falls into, determining how references to it are created. See TypeCategory for more info.

fn definition_generics() -> Vec<GenericType>

Returns the type parameter generics of a given type. Will usually be empty except for custom types.

fn definition(opts: DefOpts<'_>) -> Result<DataType, ExportError>

Small wrapper around inline that provides definition_generics as the value for the generics arg.

fn reference( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<DataType, ExportError>

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Copy for RawModuleLocation

impl Eq for RawModuleLocation

impl StructuralPartialEq for RawModuleLocation