Struct RockLayout

pub struct RockLayout {
    pub rock_path: PathBuf,
    pub etc: PathBuf,
    pub lib: PathBuf,
    pub src: PathBuf,
    pub bin: PathBuf,
    pub conf: PathBuf,
    pub doc: PathBuf,
}

Change-agnostic way of referencing various paths for a rock.

Fields

rock_path: PathBuf

The local installation directory. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(PREFIX).

etc: PathBuf

The etc directory, containing resources.

lib: PathBuf

The lib directory, containing native libraries. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(LIBDIR).

src: PathBuf

The src directory, containing Lua sources. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(LUADIR).

bin: PathBuf

The bin directory, containing executables. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(BINDIR). This points to a global binary path at the root of the current tree by default.

conf: PathBuf

The etc/conf directory, containing configuration files. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(CONFDIR).

doc: PathBuf

The etc/doc directory, containing documentation files. Can be substituted in a rockspec’s build.build_variables and build.install_variables using $(DOCDIR).

Implementations

impl RockLayout

pub fn rockspec_path(&self) -> PathBuf

Trait Implementations

impl Debug for RockLayout

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

Formats the value using the given formatter.

impl PartialEq for RockLayout

fn eq(&self, other: &RockLayout) -> 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 UserData for RockLayout

fn add_fields<F: UserDataFields<Self>>(fields: &mut F)

Adds custom fields specific to this userdata.

fn add_methods<M>(methods: &mut M)

where M: UserDataMethods<Self>,

Adds custom methods and operators specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.

impl StructuralPartialEq for RockLayout