Control.Monad.Shell.Quote

Shell quoting

Documentation

newtype Quoted a

A value that is safely quoted so that it can be exposed to the shell.

While the constructor is exposed, you should avoid directly constucting Quoted values. Instead, use quote.

Constructors

Q

Fields

• getQ :: a

Instances

Eq a => Eq (Quoted a)

Defined in Control.Monad.Shell.Quote

Methods

(==) :: Quoted a -> Quoted a -> Bool

(/=) :: Quoted a -> Quoted a -> Bool

Ord a => Ord (Quoted a)

Defined in Control.Monad.Shell.Quote

Methods

compare :: Quoted a -> Quoted a -> Ordering

(<) :: Quoted a -> Quoted a -> Bool

(<=) :: Quoted a -> Quoted a -> Bool

(>) :: Quoted a -> Quoted a -> Bool

(>=) :: Quoted a -> Quoted a -> Bool

max :: Quoted a -> Quoted a -> Quoted a

min :: Quoted a -> Quoted a -> Quoted a

Show a => Show (Quoted a)

Defined in Control.Monad.Shell.Quote

Methods

showsPrec :: Int -> Quoted a -> ShowS

show :: Quoted a -> String

showList :: [Quoted a] -> ShowS

IsString (Quoted Text)

Defined in Control.Monad.Shell.Quote

Methods

fromString :: String -> Quoted Text

Semigroup a => Semigroup (Quoted a)

Defined in Control.Monad.Shell.Quote

Methods

(<>) :: Quoted a -> Quoted a -> Quoted a

sconcat :: NonEmpty (Quoted a) -> Quoted a

stimes :: Integral b => b -> Quoted a -> Quoted a

Monoid a => Monoid (Quoted a)

Defined in Control.Monad.Shell.Quote

Methods

mempty :: Quoted a

mappend :: Quoted a -> Quoted a -> Quoted a

mconcat :: [Quoted a] -> Quoted a

Param (Quoted Text)

Quoted Text arguments are passed as-is.

Defined in Control.Monad.Shell

Methods

toTextParam :: Quoted Text -> Env -> Text

class Quotable t where

Quotes a value to allow it to be safely exposed to the shell.

The method used is to replace ' with '"'"' and wrap the value inside single quotes. This works for POSIX shells, as well as other shells like csh.

The single quotes are omitted for simple values that do not need any quoting.

Methods

quote :: t -> Quoted Text

Instances

Quotable String

Defined in Control.Monad.Shell.Quote

Methods

quote :: String -> Quoted Text

Quotable Text

Defined in Control.Monad.Shell.Quote

Methods

quote :: Text -> Quoted Text

Show v => Quotable (Val v)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val v -> Quoted Text

Quotable (Val String)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val String -> Quoted Text

Quotable (Val Text)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val Text -> Quoted Text

newtype Val v

An arbitrary value.

Constructors

Val v

Instances

Show v => Quotable (Val v)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val v -> Quoted Text

Quotable (Val String)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val String -> Quoted Text

Quotable (Val Text)

Defined in Control.Monad.Shell.Quote

Methods

quote :: Val Text -> Quoted Text