<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Blaze/ByteString/Builder/Char8.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -fno-warn-unused-imports #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE MonoPatBinds #-}</span>
<a name="line-3"></a><span class='hs-comment'>-- ignore warning from 'import Data.Text.Encoding'</span>
<a name="line-4"></a>
<a name="line-5"></a><span class='hs-comment'>-- |</span>
<a name="line-6"></a><span class='hs-comment'>-- Module : Blaze.ByteString.Builder.Char8</span>
<a name="line-7"></a><span class='hs-comment'>-- Copyright : (c) 2010 Simon Meier</span>
<a name="line-8"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span>
<a name="line-9"></a><span class='hs-comment'>-- </span>
<a name="line-10"></a><span class='hs-comment'>-- Maintainer : Simon Meier <iridcode@gmail.com></span>
<a name="line-11"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-12"></a><span class='hs-comment'>-- Portability : tested on GHC only</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-- //Note:// This package is intended for low-level use like implementing</span>
<a name="line-15"></a><span class='hs-comment'>-- protocols. If you need to //serialize// Unicode characters use one of the </span>
<a name="line-16"></a><span class='hs-comment'>-- UTF encodings (e.g. 'Blaze.ByteString.Builder.Char.UTF-8').</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-comment'>-- 'Write's and 'Builder's for serializing the lower 8-bits of characters.</span>
<a name="line-19"></a><span class='hs-comment'>--</span>
<a name="line-20"></a><span class='hs-comment'>-- This corresponds to what the 'bytestring' package offer in</span>
<a name="line-21"></a><span class='hs-comment'>-- 'Data.ByteString.Char8'.</span>
<a name="line-22"></a><span class='hs-comment'>--</span>
<a name="line-23"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span>
<a name="line-24"></a> <span class='hs-layout'>(</span>
<a name="line-25"></a> <span class='hs-comment'>-- * Writing Latin-1 (ISO 8859-1) encodable characters to a buffer</span>
<a name="line-26"></a> <span class='hs-varid'>writeChar</span>
<a name="line-27"></a>
<a name="line-28"></a> <span class='hs-comment'>-- * Creating Builders from Latin-1 (ISO 8859-1) encodable characters</span>
<a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromChar</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromString</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromShow</span>
<a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromText</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromLazyText</span>
<a name="line-34"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span> <span class='hs-layout'>(</span><span class='hs-varid'>ord</span><span class='hs-layout'>)</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TS</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Encoding</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TS</span> <span class='hs-comment'>-- imported for documentation links</span>
<a name="line-41"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TL</span>
<a name="line-42"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Encoding</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TS</span> <span class='hs-comment'>-- imported for documentation links</span>
<a name="line-43"></a>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span>
<a name="line-45"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="writeChar"></a><span class='hs-comment'>-- | Write the lower 8-bits of a character to a buffer.</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>{-# INLINE writeChar #-}</span>
<a name="line-50"></a><span class='hs-definition'>writeChar</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Write</span>
<a name="line-51"></a><span class='hs-definition'>writeChar</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>writeWord8</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varop'>.</span> <span class='hs-varid'>ord</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="fromChar"></a><span class='hs-comment'>-- | /O(1)/. Serialize the lower 8-bits of a character.</span>
<a name="line-54"></a><span class='hs-comment'>--</span>
<a name="line-55"></a><span class='hs-definition'>fromChar</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-56"></a><span class='hs-definition'>fromChar</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromWriteSingleton</span> <span class='hs-varid'>writeChar</span>
<a name="line-57"></a>
<a name="line-58"></a><a name="fromString"></a><span class='hs-comment'>-- | /O(n)/. Serialize the lower 8-bits of all characters of a string</span>
<a name="line-59"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><span class='hs-definition'>fromString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-61"></a><span class='hs-definition'>fromString</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromWriteList</span> <span class='hs-varid'>writeChar</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="fromShow"></a><span class='hs-comment'>-- | /O(n)/. Serialize a value by 'Show'ing it and serializing the lower 8-bits</span>
<a name="line-64"></a><span class='hs-comment'>-- of the resulting string.</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-definition'>fromShow</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-67"></a><span class='hs-definition'>fromShow</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromString</span> <span class='hs-varop'>.</span> <span class='hs-varid'>show</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="fromText"></a><span class='hs-comment'>-- | /O(n)/. Serialize the lower 8-bits of all characters in the strict text.</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>{-# INLINE fromText #-}</span>
<a name="line-72"></a><span class='hs-definition'>fromText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TS</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-73"></a><span class='hs-definition'>fromText</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromString</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TS</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="fromLazyText"></a><span class='hs-comment'>-- | /O(n)/. Serialize the lower 8-bits of all characters in the lazy text.</span>
<a name="line-76"></a><span class='hs-comment'>--</span>
<a name="line-77"></a><span class='hs-comment'>{-# INLINE fromLazyText #-}</span>
<a name="line-78"></a><span class='hs-definition'>fromLazyText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TL</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-79"></a><span class='hs-definition'>fromLazyText</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromString</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TL</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span>
</pre></body>
</html>
