-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Conduit for character encoding conversion.
--   
--   <tt>conduit-iconv</tt> provides a Conduit for character encoding
--   conversion, based on the iconv library.
@package conduit-iconv
@version 0.1.1.3


-- | A <a>Conduit</a> based on the iconv library for converting a
--   <a>ByteString</a> from one character set encoding to another
module Data.Conduit.IConv

-- | Type synonym for character encoding names
--   
--   See <a>convert</a> for details.
type CharacterEncoding = String

-- | Convert text from one named character encoding to another.
--   
--   Encoding names can be e.g. <tt>"UTF-8"</tt> or <tt>"ISO-8559-1"</tt>.
--   Appending <tt>"//IGNORE"</tt> to the output encoding will cause
--   encoding errors to be ignored and the characters to be dropped,
--   <tt>"//IGNORE,TRANSLIT"</tt> will cause them to be replaced by a
--   replacement character.
--   
--   Without this encoding errors will cause an exception.
--   
--   On errors this will call <a>fail</a>
convert :: Monad m => CharacterEncoding -> CharacterEncoding -> Conduit ByteString m ByteString
