Copyright	Daniel Fischer
License	BSD3
Maintainer	Daniel Fischer <[email protected]>
Stability	Provisional
Portability	portable
Safe Haskell	None
Language	Haskell98

Data.ByteString.Search.Substitution

Description

Class for values to be substituted into strict and lazy ByteStrings by the replace functions defined in this package.

Synopsis

class Substitution a where
- substitution :: a -> [ByteString] -> [ByteString]
- prependCycle :: a -> ByteString -> ByteString

Documentation

class Substitution a where Source #

Type class of meaningful substitutions for replace functions on ByteStrings. Instances for strict and lazy ByteStrings are provided here.

Methods

substitution :: a -> [ByteString] -> [ByteString] Source #

substitution transforms a value to a substitution function.

prependCycle :: a -> ByteString -> ByteString Source #

prependCycle sub lazyBS shall prepend infinitely many copies of sub to lazyBS without entering an infinite loop in case of an empty sub, so e.g.

  prependCycle "" "ab" == "ab"

shall (quickly) evaluate to True. For non-empty sub, the cycle shall be constructed efficiently.

Instances

Instances details

Substitution ByteString Source #
Instance details Defined in Data.ByteString.Search.Substitution Methods substitution :: ByteString -> [ByteString] -> [ByteString] Source # prependCycle :: ByteString -> ByteString -> ByteString Source #
Substitution ByteString Source #
Instance details Defined in Data.ByteString.Search.Substitution Methods substitution :: ByteString -> [ByteString] -> [ByteString] Source # prependCycle :: ByteString -> ByteString -> ByteString Source #