/
Data-ByteString-Strict-Lens.html
139 lines (139 loc) · 14.1 KB
/
Data-ByteString-Strict-Lens.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?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://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Data/ByteString/Strict/Lens.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts #-}</span>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : Data.ByteString.Strict.Lens</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (C) 2012-2015 Edward Kmett</span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD-style (see the file LICENSE)</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : Edward Kmett <ekmett@gmail.com></span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : non-portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>----------------------------------------------------------------------------</span>
<a name="line-13"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Strict</span><span class='hs-varop'>.</span><span class='hs-conid'>Lens</span>
<a name="line-14"></a> <span class='hs-layout'>(</span> <span class='hs-varid'>packedBytes</span><span class='hs-layout'>,</span> <span class='hs-varid'>unpackedBytes</span><span class='hs-layout'>,</span> <span class='hs-varid'>bytes</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>packedChars</span><span class='hs-layout'>,</span> <span class='hs-varid'>unpackedChars</span><span class='hs-layout'>,</span> <span class='hs-varid'>chars</span>
<a name="line-16"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-17"></a>
<a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Lens</span>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Lens</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Words</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Char8</span>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-comment'>-- $setup</span>
<a name="line-25"></a><span class='hs-comment'>-- >>> import Control.Lens</span>
<a name="line-26"></a><span class='hs-comment'>-- >>> import Numeric.Lens</span>
<a name="line-27"></a>
<a name="line-28"></a><a name="packedBytes"></a><span class='hs-comment'>-- | 'Data.ByteString.pack' (or 'Data.ByteString.unpack') a list of bytes into a 'ByteString'</span>
<a name="line-29"></a><span class='hs-comment'>--</span>
<a name="line-30"></a><span class='hs-comment'>-- @</span>
<a name="line-31"></a><span class='hs-comment'>-- 'packedBytes' ≡ 'from' 'unpackedBytes'</span>
<a name="line-32"></a><span class='hs-comment'>-- 'Data.ByteString.pack' x ≡ x '^.' 'packedBytes'</span>
<a name="line-33"></a><span class='hs-comment'>-- 'Data.ByteString.unpack' x ≡ x '^.' 'from' 'packedBytes'</span>
<a name="line-34"></a><span class='hs-comment'>-- @</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><span class='hs-comment'>-- >>> [104,101,108,108,111]^.packedBytes</span>
<a name="line-37"></a><span class='hs-comment'>-- "hello"</span>
<a name="line-38"></a><span class='hs-definition'>packedBytes</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Iso'</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Word8</span><span class='hs-keyglyph'>]</span> <span class='hs-conid'>ByteString</span>
<a name="line-39"></a><span class='hs-definition'>packedBytes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>iso</span> <span class='hs-conid'>Words</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varid'>unpackStrict</span>
<a name="line-40"></a><span class='hs-comment'>{-# INLINE packedBytes #-}</span>
<a name="line-41"></a>
<a name="line-42"></a><a name="unpackedBytes"></a><span class='hs-comment'>-- | 'Data.ByteString.unpack' (or 'Data.ByteString.pack') a 'ByteString' into a list of bytes</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- @</span>
<a name="line-45"></a><span class='hs-comment'>-- 'unpackedBytes' ≡ 'from' 'packedBytes'</span>
<a name="line-46"></a><span class='hs-comment'>-- 'Data.ByteString.unpack' x ≡ x '^.' 'unpackedBytes'</span>
<a name="line-47"></a><span class='hs-comment'>-- 'Data.ByteString.pack' x ≡ x '^.' 'from' 'unpackedBytes'</span>
<a name="line-48"></a><span class='hs-comment'>-- @</span>
<a name="line-49"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><span class='hs-comment'>-- >>> "hello"^.packedChars.unpackedBytes</span>
<a name="line-51"></a><span class='hs-comment'>-- [104,101,108,108,111]</span>
<a name="line-52"></a><span class='hs-definition'>unpackedBytes</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Iso'</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Word8</span><span class='hs-keyglyph'>]</span>
<a name="line-53"></a><span class='hs-definition'>unpackedBytes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>from</span> <span class='hs-varid'>packedBytes</span>
<a name="line-54"></a><span class='hs-comment'>{-# INLINE unpackedBytes #-}</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="bytes"></a><span class='hs-comment'>-- | Traverse each 'Word8' in a 'ByteString'.</span>
<a name="line-57"></a><span class='hs-comment'>--</span>
<a name="line-58"></a><span class='hs-comment'>-- This 'Traversal' walks the 'ByteString' in a tree-like fashion</span>
<a name="line-59"></a><span class='hs-comment'>-- enable zippers to seek to locations in logarithmic time and accelerating</span>
<a name="line-60"></a><span class='hs-comment'>-- many monoidal queries, but up to associativity (and constant factors)</span>
<a name="line-61"></a><span class='hs-comment'>-- it is equivalent to the much slower:</span>
<a name="line-62"></a><span class='hs-comment'>--</span>
<a name="line-63"></a><span class='hs-comment'>-- @</span>
<a name="line-64"></a><span class='hs-comment'>-- 'bytes' ≡ 'unpackedBytes' '.' 'traversed'</span>
<a name="line-65"></a><span class='hs-comment'>-- @</span>
<a name="line-66"></a><span class='hs-comment'>--</span>
<a name="line-67"></a><span class='hs-comment'>-- >>> anyOf bytes (== 0x80) (Char8.pack "hello")</span>
<a name="line-68"></a><span class='hs-comment'>-- False</span>
<a name="line-69"></a><span class='hs-comment'>--</span>
<a name="line-70"></a><span class='hs-comment'>-- Note that when just using this as a 'Setter', @'setting' 'Data.ByteString.map'@</span>
<a name="line-71"></a><span class='hs-comment'>-- can be more efficient.</span>
<a name="line-72"></a><span class='hs-definition'>bytes</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IndexedTraversal'</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>ByteString</span> <span class='hs-conid'>Word8</span>
<a name="line-73"></a><span class='hs-definition'>bytes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>traversedStrictTree</span>
<a name="line-74"></a><span class='hs-comment'>{-# INLINE bytes #-}</span>
<a name="line-75"></a>
<a name="line-76"></a><a name="packedChars"></a><span class='hs-comment'>-- | 'Data.ByteString.Char8.pack' (or 'Data.ByteString.Char8.unpack') a list of characters into a 'ByteString'</span>
<a name="line-77"></a><span class='hs-comment'>--</span>
<a name="line-78"></a><span class='hs-comment'>-- When writing back to the 'ByteString' it is assumed that every 'Char'</span>
<a name="line-79"></a><span class='hs-comment'>-- lies between @'\x00'@ and @'\xff'@.</span>
<a name="line-80"></a><span class='hs-comment'>--</span>
<a name="line-81"></a><span class='hs-comment'>-- @</span>
<a name="line-82"></a><span class='hs-comment'>-- 'packedChars' ≡ 'from' 'unpackedChars'</span>
<a name="line-83"></a><span class='hs-comment'>-- 'Data.ByteString.Char8.pack' x ≡ x '^.' 'packedChars'</span>
<a name="line-84"></a><span class='hs-comment'>-- 'Data.ByteString.Char8.unpack' x ≡ x '^.' 'from' 'packedChars'</span>
<a name="line-85"></a><span class='hs-comment'>-- @</span>
<a name="line-86"></a><span class='hs-comment'>--</span>
<a name="line-87"></a><span class='hs-comment'>-- >>> "hello"^.packedChars.each.re (base 16 . enum).to (\x -> if Prelude.length x == 1 then '0':x else x)</span>
<a name="line-88"></a><span class='hs-comment'>-- "68656c6c6f"</span>
<a name="line-89"></a><span class='hs-definition'>packedChars</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Iso'</span> <span class='hs-conid'>String</span> <span class='hs-conid'>ByteString</span>
<a name="line-90"></a><span class='hs-definition'>packedChars</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>iso</span> <span class='hs-conid'>Char8</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varid'>unpackStrict8</span>
<a name="line-91"></a><span class='hs-comment'>{-# INLINE packedChars #-}</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="unpackedChars"></a><span class='hs-comment'>-- | 'Data.ByteString.Char8.unpack' (or 'Data.ByteString.Char8.pack') a list of characters into a 'ByteString'</span>
<a name="line-94"></a><span class='hs-comment'>--</span>
<a name="line-95"></a><span class='hs-comment'>-- When writing back to the 'ByteString' it is assumed that every 'Char'</span>
<a name="line-96"></a><span class='hs-comment'>-- lies between @'\x00'@ and @'\xff'@.</span>
<a name="line-97"></a><span class='hs-comment'>--</span>
<a name="line-98"></a><span class='hs-comment'>-- @</span>
<a name="line-99"></a><span class='hs-comment'>-- 'unpackedChars' ≡ 'from' 'packedChars'</span>
<a name="line-100"></a><span class='hs-comment'>-- 'Data.ByteString.Char8.unpack' x ≡ x '^.' 'unpackedChars'</span>
<a name="line-101"></a><span class='hs-comment'>-- 'Data.ByteString.Char8.pack' x ≡ x '^.' 'from' 'unpackedChars'</span>
<a name="line-102"></a><span class='hs-comment'>-- @</span>
<a name="line-103"></a><span class='hs-comment'>--</span>
<a name="line-104"></a><span class='hs-comment'>-- >>> [104,101,108,108,111]^.packedBytes.unpackedChars</span>
<a name="line-105"></a><span class='hs-comment'>-- "hello"</span>
<a name="line-106"></a><span class='hs-definition'>unpackedChars</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Iso'</span> <span class='hs-conid'>ByteString</span> <span class='hs-conid'>String</span>
<a name="line-107"></a><span class='hs-definition'>unpackedChars</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>from</span> <span class='hs-varid'>packedChars</span>
<a name="line-108"></a><span class='hs-comment'>{-# INLINE unpackedChars #-}</span>
<a name="line-109"></a>
<a name="line-110"></a><a name="chars"></a><span class='hs-comment'>-- | Traverse the individual bytes in a 'ByteString' as characters.</span>
<a name="line-111"></a><span class='hs-comment'>--</span>
<a name="line-112"></a><span class='hs-comment'>-- When writing back to the 'ByteString' it is assumed that every 'Char'</span>
<a name="line-113"></a><span class='hs-comment'>-- lies between @'\x00'@ and @'\xff'@.</span>
<a name="line-114"></a><span class='hs-comment'>--</span>
<a name="line-115"></a><span class='hs-comment'>-- This 'Traversal' walks the 'ByteString' in a tree-like fashion</span>
<a name="line-116"></a><span class='hs-comment'>-- enable zippers to seek to locations in logarithmic time and accelerating</span>
<a name="line-117"></a><span class='hs-comment'>-- many monoidal queries, but up to associativity (and constant factors)</span>
<a name="line-118"></a><span class='hs-comment'>-- it is equivalent to the much slower:</span>
<a name="line-119"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><span class='hs-comment'>-- @</span>
<a name="line-121"></a><span class='hs-comment'>-- 'chars' = 'unpackedChars' '.' 'traverse'</span>
<a name="line-122"></a><span class='hs-comment'>-- @</span>
<a name="line-123"></a><span class='hs-comment'>--</span>
<a name="line-124"></a><span class='hs-comment'>-- >>> anyOf chars (== 'h') "hello"</span>
<a name="line-125"></a><span class='hs-comment'>-- True</span>
<a name="line-126"></a><span class='hs-definition'>chars</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IndexedTraversal'</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>ByteString</span> <span class='hs-conid'>Char</span>
<a name="line-127"></a><span class='hs-definition'>chars</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>traversedStrictTree8</span>
<a name="line-128"></a><span class='hs-comment'>{-# INLINE chars #-}</span>
</pre></body>
</html>