Safe Haskell	None
Language	Haskell2010

Source.Source

Contents

Measurement
En/decoding
Slicing
Splitting

Description

Source models source code, represented as a thin wrapper around a ByteString with conveniences for splitting by line, slicing, etc.

This module is intended to be imported qualified to avoid name clashes with Prelude:

import qualified Source.Source as Source

Synopsis

data Source
bytes :: Source -> ByteString
fromUTF8 :: ByteString -> Source
length :: Source -> Int
null :: Source -> Bool
totalRange :: Source -> Range
totalSpan :: Source -> Span
fromText :: Text -> Source
toText :: Source -> Text
slice :: Source -> Range -> Source
drop :: Int -> Source -> Source
take :: Int -> Source -> Source
lines :: Source -> [Source]
lineRanges :: Source -> [Range]
lineRangesWithin :: Source -> Range -> [Range]
newlineIndices :: ByteString -> [Int]

Documentation

data Source Source #

The contents of a source file. This is represented as a UTF-8 ByteString under the hood. Construct these with fromUTF8; obviously, passing fromUTF8 non-UTF8 bytes will cause crashes.

Instances

Instances details

Eq Source Source #
Instance details Defined in Source.Source Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #
Show Source Source #
Instance details Defined in Source.Source Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #
IsString Source Source #
Instance details Defined in Source.Source Methods fromString :: String -> Source #
Generic Source Source #
Instance details Defined in Source.Source Associated Types type Rep Source :: Type -> Type # Methods from :: Source -> Rep Source x # to :: Rep Source x -> Source #
Semigroup Source Source #
Instance details Defined in Source.Source Methods (<>) :: Source -> Source -> Source # sconcat :: NonEmpty Source -> Source # stimes :: Integral b => b -> Source -> Source #
Monoid Source Source #
Instance details Defined in Source.Source Methods mempty :: Source # mappend :: Source -> Source -> Source # mconcat :: [Source] -> Source #
NFData Source Source #
Instance details Defined in Source.Source Methods rnf :: Source -> () #
FromJSON Source Source #
Instance details Defined in Source.Source Methods parseJSON :: Value -> Parser Source # parseJSONList :: Value -> Parser [Source] #
type Rep Source Source #
Instance details Defined in Source.Source type Rep Source = D1 ('MetaData "Source" "Source.Source" "semantic-source-0.0.2.0-inplace" 'True) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))