fs-effectful
Safe HaskellNone
LanguageGHC2021

Effectful.FileSystem.FileReader.Static

Description

Provides a static effect for reading files.

Since: 0.1

Synopsis

Effect

data FileReader (a :: Type -> Type) b Source #

Static effect for reading files.

Since: 0.1

Instances

Instances details
type DispatchOf FileReader Source # 
Instance details

Defined in Effectful.FileSystem.FileReader.Static

type DispatchOf FileReader = 'Static 'WithSideEffects
data StaticRep FileReader Source # 
Instance details

Defined in Effectful.FileSystem.FileReader.Static

data StaticRep FileReader = MkFileReader

readBinaryFile :: forall (es :: [Effect]). (FileReader :> es, HasCallStack) => OsPath -> Eff es ByteString Source #

Since: 0.1

Handlers

runFileReader :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (FileReader ': es) a -> Eff es a Source #

Runs FileReader in IO.

Since: 0.1

UTF-8 Utils

readFileUtf8 :: forall (es :: [Effect]). (FileReader :> es, HasCallStack) => OsPath -> Eff es (Either UnicodeException Text) Source #

Reads a file as UTF-8.

Since: 0.1

readFileUtf8Lenient :: forall (es :: [Effect]). (FileReader :> es, HasCallStack) => OsPath -> Eff es Text Source #

Reads a file as UTF-8 in lenient mode.

Since: 0.1

readFileUtf8ThrowM :: forall (es :: [Effect]). (FileReader :> es, HasCallStack) => OsPath -> Eff es Text Source #

Decodes a file as UTF-8. Throws UnicodeException for decode errors.

Since: 0.1

decodeUtf8 :: ByteString -> Either UnicodeException Text Source #

Decodes a ByteString to UTF-8.

Since: fs-utils-0.1

decodeUtf8Lenient :: ByteString -> Text Source #

Leniently decodes a ByteString to UTF-8.

Since: fs-utils-0.1

decodeUtf8ThrowM :: (HasCallStack, MonadThrow m) => ByteString -> m Text Source #

Decodes a ByteString to UTF-8. Can throw UnicodeException.

Since: fs-utils-0.1

Re-exports

data ByteString #

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.

Instances

Instances details
NFData ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

rnf :: ByteString -> () #

Monoid ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

mempty :: ByteString #

mappend :: ByteString -> ByteString -> ByteString #

mconcat :: [ByteString] -> ByteString #

Semigroup ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

(<>) :: ByteString -> ByteString -> ByteString #

sconcat :: NonEmpty ByteString -> ByteString #

stimes :: Integral b => b -> ByteString -> ByteString #

Data ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteString -> c ByteString #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteString #

toConstr :: ByteString -> Constr #

dataTypeOf :: ByteString -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteString) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteString) #

gmapT :: (forall b. Data b => b -> b) -> ByteString -> ByteString #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r #

gmapQ :: (forall d. Data d => d -> u) -> ByteString -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteString -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString #

IsString ByteString #

Beware: fromString truncates multi-byte characters to octets. e.g. "枯朶に烏のとまりけり秋の暮" becomes �6k�nh~�Q��n�

Instance details

Defined in Data.ByteString.Internal.Type

Methods

fromString :: String -> ByteString #

IsList ByteString #

Since: bytestring-0.10.12.0

Instance details

Defined in Data.ByteString.Internal.Type

Associated Types

type Item ByteString 
Instance details

Defined in Data.ByteString.Internal.Type

type Item ByteString = Word8

Methods

fromList :: [Item ByteString] -> ByteString #

fromListN :: Int -> [Item ByteString] -> ByteString #

toList :: ByteString -> [Item ByteString] #

Read ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

readsPrec :: Int -> ReadS ByteString #

readList :: ReadS [ByteString] #

readPrec :: ReadPrec ByteString #

readListPrec :: ReadPrec [ByteString] #

Show ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

showsPrec :: Int -> ByteString -> ShowS #

show :: ByteString -> String #

showList :: [ByteString] -> ShowS #

Eq ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

(==) :: ByteString -> ByteString -> Bool #

(/=) :: ByteString -> ByteString -> Bool #

Ord ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

Methods

compare :: ByteString -> ByteString -> Ordering #

(<) :: ByteString -> ByteString -> Bool #

(<=) :: ByteString -> ByteString -> Bool #

(>) :: ByteString -> ByteString -> Bool #

(>=) :: ByteString -> ByteString -> Bool #

max :: ByteString -> ByteString -> ByteString #

min :: ByteString -> ByteString -> ByteString #

Lift ByteString #

Since: bytestring-0.11.2.0

Instance details

Defined in Data.ByteString.Internal.Type

Methods

lift :: Quote m => ByteString -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => ByteString -> Code m ByteString #

type Item ByteString # 
Instance details

Defined in Data.ByteString.Internal.Type

type Item ByteString = Word8

type OsPath = OsString #

Type representing filenames/pathnames.

This type doesn't add any guarantees over OsString.

data Text #

A space efficient, packed, unboxed Unicode text type.

Instances

Instances details
PrintfArg Text #

Since: text-1.2.2.0

Instance details

Defined in Data.Text

Methods

formatArg :: Text -> FieldFormatter #

parseFormat :: Text -> ModifierParser #

Binary Text #

Since: text-1.2.1.0

Instance details

Defined in Data.Text

Methods

put :: Text -> Put #

get :: Get Text #

putList :: [Text] -> Put #

NFData Text # 
Instance details

Defined in Data.Text

Methods

rnf :: Text -> () #

Monoid Text # 
Instance details

Defined in Data.Text

Methods

mempty :: Text #

mappend :: Text -> Text -> Text #

mconcat :: [Text] -> Text #

Semigroup Text #

Beware: stimes will crash if the given number does not fit into an Int.

Since: text-1.2.2.0

Instance details

Defined in Data.Text

Methods

(<>) :: Text -> Text -> Text #

sconcat :: NonEmpty Text -> Text #

stimes :: Integral b => b -> Text -> Text #

Data Text #

This instance preserves data abstraction at the cost of inefficiency. We omit reflection services for the sake of data abstraction.

This instance was created by copying the updated behavior of Data.Set.Set and Data.Map.Map. If you feel a mistake has been made, please feel free to submit improvements.

The original discussion is archived here: could we get a Data instance for Data.Text.Text?

The followup discussion that changed the behavior of Set and Map is archived here: Proposal: Allow gunfold for Data.Map, ...

Instance details

Defined in Data.Text

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Text -> c Text #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Text #

toConstr :: Text -> Constr #

dataTypeOf :: Text -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Text) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Text) #

gmapT :: (forall b. Data b => b -> b) -> Text -> Text #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Text -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Text -> r #

gmapQ :: (forall d. Data d => d -> u) -> Text -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Text -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Text -> m Text #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Text -> m Text #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Text -> m Text #

IsString Text #

Performs replacement on invalid scalar values:

>>> :set -XOverloadedStrings
>>> "\55555" :: Text
"\65533"
Instance details

Defined in Data.Text

Methods

fromString :: String -> Text #

IsList Text #

Performs replacement on invalid scalar values:

>>> :set -XOverloadedLists
>>> ['\55555'] :: Text
"\65533"

Since: text-1.2.0.0

Instance details

Defined in Data.Text

Associated Types

type Item Text 
Instance details

Defined in Data.Text

type Item Text = Char

Methods

fromList :: [Item Text] -> Text #

fromListN :: Int -> [Item Text] -> Text #

toList :: Text -> [Item Text] #

Read Text # 
Instance details

Defined in Data.Text

Methods

readsPrec :: Int -> ReadS Text #

readList :: ReadS [Text] #

readPrec :: ReadPrec Text #

readListPrec :: ReadPrec [Text] #

Show Text # 
Instance details

Defined in Data.Text.Show

Methods

showsPrec :: Int -> Text -> ShowS #

show :: Text -> String #

showList :: [Text] -> ShowS #

Eq Text # 
Instance details

Defined in Data.Text

Methods

(==) :: Text -> Text -> Bool #

(/=) :: Text -> Text -> Bool #

Ord Text # 
Instance details

Defined in Data.Text

Methods

compare :: Text -> Text -> Ordering #

(<) :: Text -> Text -> Bool #

(<=) :: Text -> Text -> Bool #

(>) :: Text -> Text -> Bool #

(>=) :: Text -> Text -> Bool #

max :: Text -> Text -> Text #

min :: Text -> Text -> Text #

Lift Text #

Since: text-1.2.4.0

Instance details

Defined in Data.Text

Methods

lift :: Quote m => Text -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Text -> Code m Text #

type Item Text # 
Instance details

Defined in Data.Text

type Item Text = Char

data UnicodeException #

An exception type for representing Unicode encoding errors.

Instances

Instances details
NFData UnicodeException # 
Instance details

Defined in Data.Text.Encoding.Error

Methods

rnf :: UnicodeException -> () #

Exception UnicodeException # 
Instance details

Defined in Data.Text.Encoding.Error

Methods

toException :: UnicodeException -> SomeException #

fromException :: SomeException -> Maybe UnicodeException #

displayException :: UnicodeException -> String #

backtraceDesired :: UnicodeException -> Bool #

Show UnicodeException # 
Instance details

Defined in Data.Text.Encoding.Error

Methods

showsPrec :: Int -> UnicodeException -> ShowS #

show :: UnicodeException -> String #

showList :: [UnicodeException] -> ShowS #

Eq UnicodeException # 
Instance details

Defined in Data.Text.Encoding.Error

Methods

(==) :: UnicodeException -> UnicodeException -> Bool #

(/=) :: UnicodeException -> UnicodeException -> Bool #