Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Core.File

Contents

File system data types
Directory API
File API
Rename/Move API
External API
Upload API
Mime API

Description

This module contains the file system logic.

Synopsis

data Entry
- = File File
- | Directory Directory
data File
data Directory
readRootDirectory :: MonadIO m => RawFilePath -> m (Maybe Directory)
newDirectory :: Directory -> FileName -> STM (Maybe Directory)
getRootDir :: Directory -> Directory
data FileName
lookupChild :: Directory -> FileName -> STM (Maybe Entry)
baseName :: RawFilePath -> RawFilePath
deleteDirectory :: MonadIO m => Directory -> Directory -> m ()
createFile :: MonadIO m => Directory -> FileName -> ByteString -> m File
readFileBS :: MonadIO m => Directory -> File -> m ByteString
writeFileBS :: MonadIO m => Directory -> File -> ByteString -> m ()
deleteFile :: MonadIO m => Directory -> File -> m ()
renameEntry :: MonadIO m => Directory -> Entry -> FileName -> m ()
moveEntry :: MonadIO m => Directory -> Directory -> Entry -> m ()
data FileLoc
getFileLoc :: Directory -> Maybe File -> FileLoc
resolveFileLoc :: Directory -> FileLoc -> STM (Maybe (Directory, Maybe File))
data PartialFile
createPartialFile :: MonadIO m => Directory -> FileName -> m PartialFile
appendPartialFile :: MonadIO m => PartialFile -> ByteString -> m ()
finalizePartialFile :: MonadIO m => PartialFile -> FileOffset -> m File
data ContentType
- = BinaryContent
- | ImageContent
- | VideoContent
- | TextContent
- | ArchiveContent
fileContentType :: File -> ContentType

File system data types

data Entry #

Entry is the base element of a file system.

Constructors

File File
Directory Directory

Instances

Instances details

ToJSON Entry #
Instance details Defined in Butler.Core.File Methods toJSON :: Entry -> Value # toEncoding :: Entry -> Encoding # toJSONList :: [Entry] -> Value # toEncodingList :: [Entry] -> Encoding #
From Entry FileName #
Instance details Defined in Butler.Core.File Methods from :: Entry -> FileName #

data File #

Instances

Instances details

ToJSON File #
Instance details Defined in Butler.Core.File Methods toJSON :: File -> Value # toEncoding :: File -> Encoding # toJSONList :: [File] -> Value # toEncodingList :: [File] -> Encoding #

data Directory #

Instances

Instances details

ToJSON Directory #
Instance details Defined in Butler.Core.File Methods toJSON :: Directory -> Value # toEncoding :: Directory -> Encoding # toJSONList :: [Directory] -> Value # toEncodingList :: [Directory] -> Encoding #

readRootDirectory :: MonadIO m => RawFilePath -> m (Maybe Directory) #

Read the root directory content, return Nothing when the file path is not a directory. You must call this function to get the first directory.

Directory API

newDirectory :: Directory -> FileName -> STM (Maybe Directory) #

getRootDir :: Directory -> Directory #

Return the outer most directory.

data FileName #

FileName are provided by the user, they must not begin or end with a /.

Instances

Instances details

FromJSON FileName #
Instance details Defined in Butler.Core.File Methods parseJSON :: Value -> Parser FileName # parseJSONList :: Value -> Parser [FileName] #
ToJSON FileName #
Instance details Defined in Butler.Core.File Methods toJSON :: FileName -> Value # toEncoding :: FileName -> Encoding # toJSONList :: [FileName] -> Value # toEncodingList :: [FileName] -> Encoding #
IsString FileName #
Instance details Defined in Butler.Core.File Methods fromString :: String -> FileName #
Monoid FileName #
Instance details Defined in Butler.Core.File Methods mempty :: FileName # mappend :: FileName -> FileName -> FileName # mconcat :: [FileName] -> FileName #
Semigroup FileName #
Instance details Defined in Butler.Core.File Methods (<>) :: FileName -> FileName -> FileName # sconcat :: NonEmpty FileName -> FileName # stimes :: Integral b => b -> FileName -> FileName #
Show FileName #
Instance details Defined in Butler.Core.File Methods showsPrec :: Int -> FileName -> ShowS # show :: FileName -> String # showList :: [FileName] -> ShowS #
Eq FileName #
Instance details Defined in Butler.Core.File Methods (==) :: FileName -> FileName -> Bool # (/=) :: FileName -> FileName -> Bool #
Ord FileName #
Instance details Defined in Butler.Core.File Methods compare :: FileName -> FileName -> Ordering # (<) :: FileName -> FileName -> Bool # (<=) :: FileName -> FileName -> Bool # (>) :: FileName -> FileName -> Bool # (>=) :: FileName -> FileName -> Bool # max :: FileName -> FileName -> FileName # min :: FileName -> FileName -> FileName #
ToHtml FileName #
Instance details Defined in Butler.Core.File Methods toHtml :: forall (m :: Type -> Type). Monad m => FileName -> HtmlT m () # toHtmlRaw :: forall (m :: Type -> Type). Monad m => FileName -> HtmlT m () #
From Entry FileName #
Instance details Defined in Butler.Core.File Methods from :: Entry -> FileName #
From FileName FileLoc #
Instance details Defined in Butler.Core.File Methods from :: FileName -> FileLoc #
From FileName Text #
Instance details Defined in Butler.Core.File Methods from :: FileName -> Text #
From FileName RawFilePath #
Instance details Defined in Butler.Core.File Methods from :: FileName -> RawFilePath #
From RawFilePath FileName #
Instance details Defined in Butler.Core.File Methods from :: RawFilePath -> FileName #

lookupChild :: Directory -> FileName -> STM (Maybe Entry) #

baseName :: RawFilePath -> RawFilePath #

deleteDirectory :: MonadIO m => Directory -> Directory -> m () #

File API

createFile :: MonadIO m => Directory -> FileName -> ByteString -> m File #

readFileBS :: MonadIO m => Directory -> File -> m ByteString #

writeFileBS :: MonadIO m => Directory -> File -> ByteString -> m () #

deleteFile :: MonadIO m => Directory -> File -> m () #

Rename/Move API

renameEntry :: MonadIO m => Directory -> Entry -> FileName -> m () #

moveEntry :: MonadIO m => Directory -> Directory -> Entry -> m () #

External API

data FileLoc #

The absolute location of a directory, for remote user.

Instances

Instances details

FromJSON FileLoc #
Instance details Defined in Butler.Core.File Methods parseJSON :: Value -> Parser FileLoc # parseJSONList :: Value -> Parser [FileLoc] #
ToJSON FileLoc #
Instance details Defined in Butler.Core.File Methods toJSON :: FileLoc -> Value # toEncoding :: FileLoc -> Encoding # toJSONList :: [FileLoc] -> Value # toEncodingList :: [FileLoc] -> Encoding #
Monoid FileLoc #
Instance details Defined in Butler.Core.File Methods mempty :: FileLoc # mappend :: FileLoc -> FileLoc -> FileLoc # mconcat :: [FileLoc] -> FileLoc #
Semigroup FileLoc #
Instance details Defined in Butler.Core.File Methods (<>) :: FileLoc -> FileLoc -> FileLoc # sconcat :: NonEmpty FileLoc -> FileLoc # stimes :: Integral b => b -> FileLoc -> FileLoc #
Show FileLoc #
Instance details Defined in Butler.Core.File Methods showsPrec :: Int -> FileLoc -> ShowS # show :: FileLoc -> String # showList :: [FileLoc] -> ShowS #
Serialise FileLoc #
Instance details Defined in Butler.Core.File Methods encode :: FileLoc -> Encoding # decode :: Decoder s FileLoc # encodeList :: [FileLoc] -> Encoding # decodeList :: Decoder s [FileLoc] #
From FileLoc Text #
Instance details Defined in Butler.Core.File Methods from :: FileLoc -> Text #
From FileName FileLoc #
Instance details Defined in Butler.Core.File Methods from :: FileName -> FileLoc #

getFileLoc :: Directory -> Maybe File -> FileLoc #

Get the absolute location of a directory.

resolveFileLoc :: Directory -> FileLoc -> STM (Maybe (Directory, Maybe File)) #

Upload API

data PartialFile #

createPartialFile :: MonadIO m => Directory -> FileName -> m PartialFile #

appendPartialFile :: MonadIO m => PartialFile -> ByteString -> m () #

finalizePartialFile :: MonadIO m => PartialFile -> FileOffset -> m File #

Mime API

data ContentType #

Constructors

BinaryContent
ImageContent
VideoContent
TextContent
ArchiveContent

Instances

Instances details

Enum ContentType #
Instance details Defined in Butler.Core.File Methods succ :: ContentType -> ContentType # pred :: ContentType -> ContentType # toEnum :: Int -> ContentType # fromEnum :: ContentType -> Int # enumFrom :: ContentType -> [ContentType] # enumFromThen :: ContentType -> ContentType -> [ContentType] # enumFromTo :: ContentType -> ContentType -> [ContentType] # enumFromThenTo :: ContentType -> ContentType -> ContentType -> [ContentType] #
Show ContentType #
Instance details Defined in Butler.Core.File Methods showsPrec :: Int -> ContentType -> ShowS # show :: ContentType -> String # showList :: [ContentType] -> ShowS #
Eq ContentType #
Instance details Defined in Butler.Core.File Methods (==) :: ContentType -> ContentType -> Bool # (/=) :: ContentType -> ContentType -> Bool #
Ord ContentType #
Instance details Defined in Butler.Core.File Methods compare :: ContentType -> ContentType -> Ordering # (<) :: ContentType -> ContentType -> Bool # (<=) :: ContentType -> ContentType -> Bool # (>) :: ContentType -> ContentType -> Bool # (>=) :: ContentType -> ContentType -> Bool # max :: ContentType -> ContentType -> ContentType # min :: ContentType -> ContentType -> ContentType #

fileContentType :: File -> ContentType #