Moduleword-wrap-0.5Haskell2010

Text.Wrap

3 types
3 values

Packageword-wrap-0.5
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWrap.hs

datadata FillStrategy

How should wrapped lines be filled (i.e. what kind of prefix should be attached?)

Constructors

NoFill
Don't do any filling (default)
FillIndent Int
Indent by this many spaces
FillPrefix Text
Prepend this text

Instances3Eq, Read, Show

Eq FillStrategyDefined in word-wrap-0.5 · Text.Wrap
Read FillStrategyDefined in word-wrap-0.5 · Text.Wrap
Show FillStrategyDefined in word-wrap-0.5 · Text.Wrap

datadata FillScope

To which lines should the fill strategy be applied?

Constructors

FillAfterFirst
Apply any fill prefix only to lines after the first line (default)
FillAll
Apply any fill prefix to all lines, even if there is only one line

Instances3Eq, Read, Show

Eq FillScopeDefined in word-wrap-0.5 · Text.Wrap
Read FillScopeDefined in word-wrap-0.5 · Text.Wrap
Show FillScopeDefined in word-wrap-0.5 · Text.Wrap

datadata WrapSettings

Settings to control how wrapping is performed.

Constructors

WrapSettings
- preserveIndentation :: Bool
  Whether to indent new lines created by wrapping when their original line was indented.
- breakLongWords :: Bool
  Whether to break in the middle of the first word on a line when that word exceeds the wrapping width.
- fillStrategy :: FillStrategy
  What kind of prefix should be applied to lines after wrapping? (default: none)
- fillScope :: FillScope
  To which lines should the fill strategy be applied? (default: all but the first)

Instances3Eq, Read, Show

Eq WrapSettingsDefined in word-wrap-0.5 · Text.Wrap
Read WrapSettingsDefined in word-wrap-0.5 · Text.Wrap
Show WrapSettingsDefined in word-wrap-0.5 · Text.Wrap

valuedefaultWrapSettings :: WrapSettings

valuewrapTextToLines :: WrapSettings -> Int -> Text -> [Text]

Wrap text at the specified width. Newlines and whitespace in the input text are preserved. Returns the lines of text in wrapped form. New lines introduced due to wrapping will have leading whitespace stripped prior to having any fill applied. Preserved indentation is always placed before any fill.

valuewrapText :: WrapSettings -> Int -> Text -> Text

Like wrapTextToLines, but returns the wrapped text reconstructed with newlines inserted at wrap points.