Data.Bits.Lens

Documentation

(|~) :: Bits c => Setting a b c c -> c -> a -> b

Bitwise .|. the target(s) of a Lens or Setter

>>> _2 |~ 6 $ ("hello",3)
("hello",7)

 (|~) :: Bits c => Setter a b c c -> c -> a -> b
 (|~) :: Bits c => Iso a b c c -> c -> a -> b
 (|~) :: Bits c => Lens a b c c -> c -> a -> b
 (|~) :: ('Monoid c', Bits c) => Traversal a b c c -> c -> a -> b

(&~) :: Bits c => Setting a b c c -> c -> a -> b

Bitwise .&. the target(s) of a Lens or Setter

>>> _2 &~ 7 $ ("hello",254)
("hello",6)

 (&~) :: Bits c => Setter a b c c -> c -> a -> b
 (&~) :: Bits c => Iso a b c c -> c -> a -> b
 (&~) :: Bits c => Lens a b c c -> c -> a -> b
 (&~) :: ('Monoid c', Bits c) => Traversal a b c c -> c -> a -> b

(<|~) :: Bits c => LensLike ((,) c) a b c c -> c -> a -> (c, b)

Bitwise .|. the target(s) of a Lens (or Traversal), returning the result (or a monoidal summary of all of the results).

>>> _2 <|~ 6 $ ("hello",3)
(7,("hello",7))

 (<|~) :: Bits c => Iso a b c c -> c -> a -> (c, b)
 (<|~) :: Bits c => Lens a b c c -> c -> a -> (c, b)
 (<|~) :: (Bits c, 'Monoid c) => Traversal a b c c -> c -> a -> (c, b)

(<&~) :: Bits c => LensLike ((,) c) a b c c -> c -> a -> (c, b)

Bitwise .&. the target(s) of a Lens or Traversal, returning the result (or a monoidal summary of all of the results).

>>> _2 <&~ 7 $ ("hello",254)
(6,("hello",6))

 (<&~) :: Bits c => Iso a b c c -> c -> a -> (c, b)
 (<&~) :: Bits c => Lens a b c c -> c -> a -> (c, b)
 (<&~) :: (Bits c, 'Monoid c) => Traversal a b c c -> c -> a -> (c, b)

(|=) :: (MonadState a m, Bits b) => Simple Setting a b -> b -> m ()

Modify the target(s) of a Simple Lens, Setter or Traversal by computing its bitwise .|. with another value.

 (|=):: (MonadState a m, Bits b) => Simple Setter a b -> b -> m ()
 (|=):: (MonadState a m, Bits b) => Simple Iso a b -> b -> m ()
 (|=):: (MonadState a m, Bits b) => Simple Lens a b -> b -> m ()
 (|=):: (MonadState a m, Bits b) => Simple Traversal a b -> b -> m ()

(&=) :: (MonadState a m, Bits b) => Simple Setting a b -> b -> m ()

Modify the target(s) of a Simple Lens, Setter or Traversal by computing its bitwise .&. with another value.

 (&=):: (MonadState a m, Bits b) => Simple Setter a b -> b -> m ()
 (&=):: (MonadState a m, Bits b) => Simple Iso a b -> b -> m ()
 (&=):: (MonadState a m, Bits b) => Simple Lens a b -> b -> m ()
 (&=):: (MonadState a m, Bits b) => Simple Traversal a b -> b -> m ()

(<|=) :: (MonadState a m, Bits b) => SimpleLensLike ((,) b) a b -> b -> m b

Modify the target(s) of a Simple Lens, (or Traversal) by computing its bitwise .|. with another value, returning the result (or a monoidal summary of all of the results traversed)

 (<|=) :: (MonadState a m, Bits b) => Simple Lens a b -> b -> m b
 (<|=) :: (MonadState a m, Bits b, Monoid b) => Simple Traversal a b -> b -> m b

(<&=) :: (MonadState a m, Bits b) => SimpleLensLike ((,) b) a b -> b -> m b

Modify the target(s) of a Simple Lens (or Traversal) by computing its bitwise .&. with another value, returning the result (or a monoidal summary of all of the results traversed)

 (<&=) :: (MonadState a m, Bits b) => Simple Lens a b -> b -> m b
 (<&=) :: (MonadState a m, Bits b, Monoid b) => Simple Traversal a b -> b -> m b

bitAt :: Bits b => Int -> SimpleIndexedLens Int b Bool

This lens can be used to access the value of the nth bit in a number.

bitAt n is only a legal Lens into b if 0 <= n < bitSize (undefined :: b)

>>> 16^.bitAt 4
True

>>> 15^.bitAt 4
False

traverseBits :: Bits b => SimpleIndexedTraversal Int b Bool

Traverse over all bits in a numeric type.

The bit position is available as the index.

>>> import Data.Word
>>> toListOf traverseBits (5 :: Word8)
[True,False,True,False,False,False,False,False]

If you supply this an Integer, the result will be an infinite Traversal that can be productively consumed.