Yesod.Static.Streamly.Internal

WARNING

This module is considered internal.

The Package Versioning Policy does not apply.

The contents of this module may change in any way whatsoever and without any warning between minor versions of this package.

Authors importing this library are expected to track development closely.

All credit goes to the author(s)/maintainer(s) of the containers library for the above warning text.

Description

This library utilizes Streamly's superb performance characteristics to replace some of Yesod's functionality with streamly-based functionality.

Yesod.Static Replacement functions (INTERNAL)

mkStaticFilesStreamly :: FilePath -> Int -> Q [Dec]

A replacement of mkStaticFiles.

mkStaticFilesStreamly'

Arguments

:: FilePath

static directory

-> Bool

append checksum query parameter

-> Int

buffer size

-> Q [Dec]

A replacement of mkStaticFiles'.

mkStaticFilesListStreamly

Arguments

:: FilePath

static directory

-> [[String]]

list of files to create identifiers for

-> Bool

append checksum query parameter

-> Int

buffer size

-> Q [Dec]

A replacement of mkStaticFilesList.

mkStaticFilesListStreamly'

Arguments

:: FilePath

static directory

-> [([String], [String])]

list of files to create identifiers for, where the first argument of the tuple is the identifier alias and the second is the actual file name

-> Bool

append checksum query parameter

-> Int

buffer size

-> Q [Dec]

A replacement of mkStaticFilesList'.

cachedETagLookupDevelStreamly :: FilePath -> Int -> IO ETagLookup

A replacement of cachedETagLookupDevel.

cachedETagLookupStreamly :: FilePath -> Int -> IO ETagLookup

A replacement of cachedETagLookup.

mkHashMapStreamly :: FilePath -> Int -> IO (Map FilePath ByteString)

A replacement of mkHashMap.

notHiddenStreamly :: FilePath -> Bool

A replacement of notHidden.

getFileListPiecesStreamly :: FilePath -> IO [[String]]

A replacement of getFileListPieces.

pathFromRawPiecesStreamly :: FilePath -> [String] -> FilePath

A replacement of pathFromRawPieces.

data CombineTypeStreamly

A replacement of CombineType.

Constructors

JS

CSS

data CombineSettingsStreamly

A replacement of CombineSettings.

Constructors

CombineSettingsStreamly

Fields

• csStaticDir :: FilePath

  File path containing static files.

  Default: static

  Since 1.2.0

• csCssPostProcess :: [FilePath] -> ByteString -> IO ByteString

  Post processing to be performed on CSS files.

  Default: Pass-through.

  Since 1.2.0

• csJsPostProcess :: [FilePath] -> ByteString -> IO ByteString

  Post processing to be performed on Javascript files.

  Default: Pass-through.

  Since 1.2.0

• csCssPreProcess :: Text -> IO Text

  Pre-processing to be performed on CSS files.

  Default: convert all occurences of static to ../

  Since 1.2.0

• csJsPreProcess :: Text -> IO Text

  Pre-processing to be performed on Javascript files.

  Default: Pass-through.

  Since 1.2.0

• csCombinedFolder :: FilePath

  Subfolder to put combined files into.

  Default: combined

  Since 1.2.0

Instances

Default CombineSettingsStreamly

Defined in Yesod.Static.Streamly.Internal

Methods

def :: CombineSettingsStreamly

liftRoutesStreamly :: [Route Static] -> Q Exp

A replacement of liftRoutes.

combineStaticsStreamly'

Arguments

:: CombineTypeStreamly

-> CombineSettingsStreamly

-> [Route Static]

files to combine

-> Int

-> Q Exp

A more performant replacement of combineStatics'.

base64md5FileStreamly :: FilePath -> Int -> IO String

A replacement of base64md5File.

base64md5Streamly :: ByteString -> String

A replacement of base64md5.

base64Streamly :: ByteString -> String

A replacement of base64.

hashFileStreamly :: (MonadIO m, HashAlgorithm hash) => FilePath -> Int -> m (Digest hash)

A more performant replacement of hashFile found in Crypto.Hash.Conduit.

sinkHashStreamly :: (Monad m, HashAlgorithm hash) => ByteString -> m (Digest hash)

A more performant replacement of sinkHash found in Crypto.Hash.Conduit.