CabalGild.Type.Block

This module defines the Block data type.

Documentation

data Block

A block of text, which is made up of multiple lines and can have blank lines before and/or after it.

Constructors

Block

Fields

• lineBefore :: Bool

  Does this block have a blank line before it?

• lines :: [Line]
• lineAfter :: Bool

  Does this block have a blank line after it?

Instances

Monoid Block

The empty block has no lines and also no blank lines before or after.

Defined in CabalGild.Type.Block

Methods

mempty :: Block

mappend :: Block -> Block -> Block

mconcat :: [Block] -> Block

Semigroup Block

Joins two blocks together by adding a blank line between them if necessary. (A blank line is necessary if either block needs a space.) If either block is empty, the other block is returned.

Defined in CabalGild.Type.Block

Methods

(<>) :: Block -> Block -> Block

sconcat :: NonEmpty Block -> Block

stimes :: Integral b => b -> Block -> Block

Show Block

Defined in CabalGild.Type.Block

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Eq Block

Defined in CabalGild.Type.Block

Methods

(==) :: Block -> Block -> Bool

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

fromLine :: Line -> Block

Converts a single line into a block without blank lines before or after.

isEmpty :: Block -> Bool

Returns True if the block has no lines.

lineAfterLens :: Lens' Block Bool

A lens for the lineAfter field.

lineBeforeLens :: Lens' Block Bool

A lens for the lineBefore field.

toByteString :: Block -> ByteString

Converts a block into a ByteString by joining the lines together with newline characters. Note that unline unlines, there will be no trailing newline unless lineAfter is True.