Data.Rope.UTF16

Documentation

data Rope

A SplayTree of Text values optimised for being indexed by and modified at UTF-16 code points and row/column (RowColumn) positions. Internal invariant: No empty Chunks in the SplayTree

Instances

Eq Rope

Methods

(==) :: Rope -> Rope -> Bool

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

Ord Rope

Methods

compare :: Rope -> Rope -> Ordering

(<) :: Rope -> Rope -> Bool

(<=) :: Rope -> Rope -> Bool

(>) :: Rope -> Rope -> Bool

(>=) :: Rope -> Rope -> Bool

max :: Rope -> Rope -> Rope

min :: Rope -> Rope -> Rope

Show Rope

Methods

showsPrec :: Int -> Rope -> ShowS

show :: Rope -> String

showList :: [Rope] -> ShowS

IsString Rope

Methods

fromString :: String -> Rope

Semigroup Rope

Append joins adjacent chunks if that can be done while staying below chunkLength.

Methods

(<>) :: Rope -> Rope -> Rope

sconcat :: NonEmpty Rope -> Rope

stimes :: Integral b => b -> Rope -> Rope

Monoid Rope

Methods

mempty :: Rope

mappend :: Rope -> Rope -> Rope

mconcat :: [Rope] -> Rope

Measured Position Rope

Methods

measure :: Rope -> Position

Conversions to and from Text and String

toText :: Rope -> Text

toLazyText :: Rope -> Text

fromText :: Text -> Rope

toString :: Rope -> String

Chunking

toChunks :: Rope -> [Text]

The raw Text data that the Rope is built from

unconsChunk :: Rope -> Maybe (Text, Rope)

Get the first chunk and the rest of the Rope if non-empty

unsnocChunk :: Rope -> Maybe (Rope, Text)

Get the last chunk and the rest of the Rope if non-empty

UTF-16 code point indexing

length :: Rope -> Int

Length in code points (not characters)

splitAt :: Int -> Rope -> (Rope, Rope)

Split the rope at the nth code point (not character)

take :: Int -> Rope -> Rope

Take the first n code points (not characters)

drop :: Int -> Rope -> Rope

Drop the first n code points (not characters)

rowColumnCodePoints :: RowColumn -> Rope -> Int

Get the code point index in the rope that corresponds to a RowColumn position

Breaking by predicate

span :: (Char -> Bool) -> Rope -> (Rope, Rope)

break :: (Char -> Bool) -> Rope -> (Rope, Rope)

takeWhile :: (Char -> Bool) -> Rope -> Rope

dropWhile :: (Char -> Bool) -> Rope -> Rope