hslua-module-path-1.1.1: Lua module to work with file paths.
Copyright© 2021-2024 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Safe HaskellNone
LanguageHaskell2010

HsLua.Module.Path

Description

Lua module to work with file paths.

Synopsis

Module

documentedModule :: LuaError e => Module e #

The path module specification.

Fields

separator :: Field e #

Wrapper for pathSeparator.

search_path_separator :: Field e #

Wrapper for searchPathSeparator.

Path manipulation

add_extension :: DocumentedFunction e #

Adds an extension to a file path. Wraps addExtension.

combine :: DocumentedFunction e #

Join two paths with a directory separator. Wraps combine.

directory :: DocumentedFunction e #

See Path.takeDirectory

filename :: DocumentedFunction e #

See Path.takeFilename

is_absolute :: DocumentedFunction e #

See Path.isAbsolute

is_relative :: DocumentedFunction e #

See Path.isRelative

join :: LuaError e => DocumentedFunction e #

See Path.joinPath

make_relative :: DocumentedFunction e #

normalize :: DocumentedFunction e #

See Path.normalise

split :: LuaError e => DocumentedFunction e #

See Path.splitDirectories.

Note that this does not wrap splitPath, as that function adds trailing slashes to each directory, which is often inconvenient.

split_extension :: DocumentedFunction e #

See Path.splitExtension

split_search_path :: LuaError e => DocumentedFunction e #

Wraps function splitSearchPath.

treat_strings_as_paths :: LuaError e => DocumentedFunction e #