Safe Haskell	None
Language	Haskell2010

Data.Git.Formats

Description

This module provides some standard formats used for correctness across miss. In many cases git only allows specific subsets of bytestrings due to parsing ambiguity or system restrictions.

Synopsis

data SafeString
safeString :: MonadFail m => ByteString -> m SafeString
getSS :: SafeString -> ByteString
data LfFree
lfFree :: MonadFail m => ByteString -> m LfFree
isLfFree :: ByteString -> Bool
getLfFree :: LfFree -> ByteString

Documentation

data SafeString Source #

Strings allowed in email addresses.

Instances

Eq SafeString Source #
Instance details Defined in Data.Git.Formats Methods (==) :: SafeString -> SafeString -> Bool # (/=) :: SafeString -> SafeString -> Bool #
Ord SafeString Source #
Instance details Defined in Data.Git.Formats Methods compare :: SafeString -> SafeString -> Ordering # (<) :: SafeString -> SafeString -> Bool # (<=) :: SafeString -> SafeString -> Bool # (>) :: SafeString -> SafeString -> Bool # (>=) :: SafeString -> SafeString -> Bool # max :: SafeString -> SafeString -> SafeString # min :: SafeString -> SafeString -> SafeString #
Show SafeString Source #
Instance details Defined in Data.Git.Formats Methods showsPrec :: Int -> SafeString -> ShowS # show :: SafeString -> String # showList :: [SafeString] -> ShowS #
IsString SafeString Source #
Instance details Defined in Data.Git.Formats Methods fromString :: String -> SafeString #
Semigroup SafeString Source #
Instance details Defined in Data.Git.Formats Methods (<>) :: SafeString -> SafeString -> SafeString # sconcat :: NonEmpty SafeString -> SafeString # stimes :: Integral b => b -> SafeString -> SafeString #
Monoid SafeString Source #
Instance details Defined in Data.Git.Formats Methods mempty :: SafeString # mappend :: SafeString -> SafeString -> SafeString # mconcat :: [SafeString] -> SafeString #

safeString :: MonadFail m => ByteString -> m SafeString Source #

Try to make a SafeString.

getSS :: SafeString -> ByteString Source #

Get a ByteString out of a SafeString

data LfFree Source #

The restricted subset of ByteStrings that do not include a linefeed.

Instances

Eq LfFree Source #
Instance details Defined in Data.Git.Formats Methods (==) :: LfFree -> LfFree -> Bool # (/=) :: LfFree -> LfFree -> Bool #
Ord LfFree Source #
Instance details Defined in Data.Git.Formats Methods compare :: LfFree -> LfFree -> Ordering # (<) :: LfFree -> LfFree -> Bool # (<=) :: LfFree -> LfFree -> Bool # (>) :: LfFree -> LfFree -> Bool # (>=) :: LfFree -> LfFree -> Bool # max :: LfFree -> LfFree -> LfFree # min :: LfFree -> LfFree -> LfFree #
Show LfFree Source #
Instance details Defined in Data.Git.Formats Methods showsPrec :: Int -> LfFree -> ShowS # show :: LfFree -> String # showList :: [LfFree] -> ShowS #
IsString LfFree Source #
Instance details Defined in Data.Git.Formats Methods fromString :: String -> LfFree #
Semigroup LfFree Source #
Instance details Defined in Data.Git.Formats Methods (<>) :: LfFree -> LfFree -> LfFree # sconcat :: NonEmpty LfFree -> LfFree # stimes :: Integral b => b -> LfFree -> LfFree #
Monoid LfFree Source #
Instance details Defined in Data.Git.Formats Methods mempty :: LfFree # mappend :: LfFree -> LfFree -> LfFree # mconcat :: [LfFree] -> LfFree #

lfFree :: MonadFail m => ByteString -> m LfFree Source #

Safe constructor for LfFree

isLfFree :: ByteString -> Bool Source #

True when lfFree will result in a Just

getLfFree :: LfFree -> ByteString Source #

Get the ByteString out of a LfFree