CabalGild.Type.Chunk

This module defines the Chunk data type.

Documentation

data Chunk

A chunk of text, which is made up of a byte string and can have blank spaces before and/or after it.

Constructors

Chunk

Fields

• spaceBefore :: Bool

  Does this chunk have a blank space before it?

• value :: ByteString
• spaceAfter :: Bool

  Does this chunk have a blank space after it?

Instances

Monoid Chunk

The empty chunk has no value and also no blank spaces before or after.

Defined in CabalGild.Type.Chunk

Methods

mempty :: Chunk

mappend :: Chunk -> Chunk -> Chunk

mconcat :: [Chunk] -> Chunk

Semigroup Chunk

Joins two chunks together by adding a blank space between them if necessary. (A blank space is necessary if both chunks need a space.) If either chunk is empty, the other chunk is returned.

Defined in CabalGild.Type.Chunk

Methods

(<>) :: Chunk -> Chunk -> Chunk

sconcat :: NonEmpty Chunk -> Chunk

stimes :: Integral b => b -> Chunk -> Chunk

Show Chunk

Defined in CabalGild.Type.Chunk

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

Eq Chunk

Defined in CabalGild.Type.Chunk

Methods

(==) :: Chunk -> Chunk -> Bool

(/=) :: Chunk -> Chunk -> Bool

colon :: Chunk

A colon with a space after.

fromByteString :: ByteString -> Chunk

Converts a byte string into a chunk without blank spaces before or after.

isEmpty :: Chunk -> Bool

Returns True if the chunk's byte string is empty.

spaceAfterLens :: Lens' Chunk Bool

A lens for the spaceAfter field.

spaceBeforeLens :: Lens' Chunk Bool

A lens for the spaceBefore field.