Safe Haskell	Safe-Inferred
Language	Haskell2010

Dojang.Types.FilePathExpression

Documentation

An environment variable.

An expression that can be used to build a file path.

Constructors

BareComponent Text	A bare component of a file path. E.g., `foo` and `bar` in `foobar`.
Root (Maybe Char)	The root of a file path. E.g., `/` on POSIX systems or @C:@ on Windows. The `Maybe` `Char` is the drive letter on Windows, if present. On POSIX systems, this is always `Nothing`.
Concatenation FilePathExpression FilePathExpression	A concatenation of two `FilePathExpression`s. E.g., `${FOO}bar` is a concatenation of `${FOO}` and `bar`.
PathSeparator FilePathExpression FilePathExpression	A path separator which combines two `FilePathExpression`s. E.g., `/` on POSIX systems or @@ on Windows.
Substitution EnvironmentVariable	A simple substitution of an environment variable. E.g., `$FOO` or `${BAR}`.
SubstitutionWithDefault EnvironmentVariable FilePathExpression	A substitution of an environment variable with a default value for when the environment variable is not set. E.g., `${FOO:-this value is used if FOO is not set or is empty}`.
ConditionalSubstitution EnvironmentVariable FilePathExpression	A conditional substitution of an environment variable with an expression to be expanded if the environment variable is set. E.g., `${FOO:+this value is used if FOO is set and non-empty}`.

Instances details

IsString FilePathExpression Source #
Instance details Defined in Dojang.Types.FilePathExpression Methods fromString :: String -> FilePathExpression #
Show FilePathExpression Source #
Instance details Defined in Dojang.Types.FilePathExpression Methods showsPrec :: Int -> FilePathExpression -> ShowS # show :: FilePathExpression -> String # showList :: [FilePathExpression] -> ShowS #
Eq FilePathExpression Source #
Instance details Defined in Dojang.Types.FilePathExpression Methods (==) :: FilePathExpression -> FilePathExpression -> Bool # (/=) :: FilePathExpression -> FilePathExpression -> Bool #
Hashable FilePathExpression Source #
Instance details Defined in Dojang.Types.FilePathExpression Methods hashWithSalt :: Int -> FilePathExpression -> Int # hash :: FilePathExpression -> Int #

Converts a FilePathExpression to a textual representation.

Concatenates two FilePathExpressions. A synonym for Concatenation.

Combines two FilePathExpressions with a path separator. A synonym for PathSeparator.