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


-- | Lenses for bencoded data.
--   
--   A port of lens-aeson for bencoding.
@package bencoding-lens
@version 0.1.0.0


-- | This module exports orphan instances for <tt><a>Ixed</a>
--   <a>BValue</a></tt>, <tt><a>Plated</a> <a>BValue</a></tt>,
--   <tt><a>Ixed</a> <a>BDictMap</a></tt>, <tt><a>Plated</a>
--   <a>BDictMap</a></tt>, <tt><a>Traversable</a> <a>BDictMap</a></tt>,
--   <tt><a>FunctorWithIndex</a> <a>BDictMap</a></tt>,
--   <tt><a>FoldableWithIndex</a> <a>BDictMap</a></tt>, and
--   <tt><tt>TraversbaleWithIndex</tt> <a>BDictMap</a></tt>.
module Data.BEncode.Lens

-- | Things that can be treated as a <a>BValue</a>. Instances are provided
--   for strict and lazy <tt>ByteString</tt> as well as <a>BValue</a>s
--   themselves.
class AsBValue t
_BValue :: AsBValue t => Prism' t BValue

-- | <pre>
--   &gt;&gt;&gt; ("i3e" :: ByteString) ^? _BInteger
--   Just 3
--   </pre>
_BInteger :: AsBValue t => Prism' t BInteger

-- | <pre>
--   &gt;&gt;&gt; ("0:" :: ByteString) ^? _BString
--   Just ""
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; ("4:spam" :: ByteString) ^? _BString
--   Just "spam"
--   </pre>
_BString :: AsBValue t => Prism' t BString

-- | <pre>
--   &gt;&gt;&gt; ("le" :: ByteString) ^? _BList
--   Just []
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; ("l4:spam4:eggse" :: ByteString) ^? _BList == Just [BString "spam", BString "eggs"]
--   True
--   </pre>
_BList :: AsBValue t => Prism' t BList

-- | <pre>
--   &gt;&gt;&gt; ("de" :: ByteString) ^? _BDict
--   Just Nil
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; ("d3:cow3:moo4:spam4:eggse" :: ByteString) ^? _BDict == Just (Cons "cow" (BString "moo") (Cons "spam" (BString "eggs") Nil))
--   True
--   </pre>
_BDict :: AsBValue t => Prism' t BDict

-- | <pre>
--   &gt;&gt;&gt; ("d3:cow3:moo4:spam4:eggse" :: ByteString) ^@.. members
--   [("cow",BString "moo"),("spam",BString "eggs")]
--   </pre>
members :: AsBValue t => IndexedTraversal' BKey t BValue

-- | <pre>
--   &gt;&gt;&gt; ("d3:cow3:moo4:spam4:eggse" :: ByteString) ^? key "cow"
--   Just (BString "moo")
--   </pre>
key :: AsBValue t => BKey -> Traversal' t BValue

-- | <pre>
--   &gt;&gt;&gt; ("li0ei1ee" :: ByteString) ^? nth 0
--   Just (BInteger 0)
--   </pre>
nth :: AsBValue t => Int -> Traversal' t BValue

-- | <pre>
--   &gt;&gt;&gt; ("ll1:ae3:cow3:moo4:spam4:eggse" :: ByteString) ^.. values
--   [BList [BString "a"],BString "cow",BString "moo",BString "spam",BString "eggs"]
--   </pre>
values :: AsBValue t => IndexedTraversal' Int t BValue
instance Data.BEncode.Lens.AsBValue Data.BEncode.Types.BValue
instance Data.BEncode.Lens.AsBValue Data.ByteString.Internal.ByteString
instance Data.BEncode.Lens.AsBValue Data.ByteString.Lazy.Internal.ByteString
instance Data.Traversable.Traversable Data.BEncode.BDict.BDictMap
instance WithIndex.FoldableWithIndex Data.BEncode.BDict.BKey Data.BEncode.BDict.BDictMap
instance WithIndex.FunctorWithIndex Data.BEncode.BDict.BKey Data.BEncode.BDict.BDictMap
instance WithIndex.TraversableWithIndex Data.BEncode.BDict.BKey Data.BEncode.BDict.BDictMap
instance Control.Lens.At.At (Data.BEncode.BDict.BDictMap a)
instance Control.Lens.At.Ixed (Data.BEncode.BDict.BDictMap a)
instance Control.Lens.At.Ixed Data.BEncode.Types.BValue
instance Control.Lens.Plated.Plated Data.BEncode.Types.BValue