System.FS.API.Types

Modes

data AllowExisting

When opening a file:

Constructors

AllowExisting

The file may already exist. If it does, it is reopened. If it doesn't, it is created.

MustBeNew

The file may not yet exist. If it does, an error (FsResourceAlreadyExist) is thrown.

Instances

Show AllowExisting

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> AllowExisting -> ShowS

show :: AllowExisting -> String

showList :: [AllowExisting] -> ShowS

Condense AllowExisting

Defined in System.FS.API.Types

Methods

condense :: AllowExisting -> String

Eq AllowExisting

Defined in System.FS.API.Types

Methods

(==) :: AllowExisting -> AllowExisting -> Bool

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

data OpenMode

How to hOpen a new file.

Constructors

ReadMode

WriteMode AllowExisting

AppendMode AllowExisting

ReadWriteMode AllowExisting

Instances

Show OpenMode

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> OpenMode -> ShowS

show :: OpenMode -> String

showList :: [OpenMode] -> ShowS

Condense OpenMode

Defined in System.FS.API.Types

Methods

condense :: OpenMode -> String

Eq OpenMode

Defined in System.FS.API.Types

Methods

(==) :: OpenMode -> OpenMode -> Bool

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

data SeekMode

A mode that determines the effect of hSeek hdl mode i.

Constructors

AbsoluteSeek

the position of hdl is set to i.

RelativeSeek

the position of hdl is set to offset i from the current position.

SeekFromEnd

the position of hdl is set to offset i from the end of the file.

Instances

Enum SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

succ :: SeekMode -> SeekMode

pred :: SeekMode -> SeekMode

toEnum :: Int -> SeekMode

fromEnum :: SeekMode -> Int

enumFrom :: SeekMode -> [SeekMode]

enumFromThen :: SeekMode -> SeekMode -> [SeekMode]

enumFromTo :: SeekMode -> SeekMode -> [SeekMode]

enumFromThenTo :: SeekMode -> SeekMode -> SeekMode -> [SeekMode]

Ix SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

range :: (SeekMode, SeekMode) -> [SeekMode]

index :: (SeekMode, SeekMode) -> SeekMode -> Int

unsafeIndex :: (SeekMode, SeekMode) -> SeekMode -> Int

inRange :: (SeekMode, SeekMode) -> SeekMode -> Bool

rangeSize :: (SeekMode, SeekMode) -> Int

unsafeRangeSize :: (SeekMode, SeekMode) -> Int

Read SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

readsPrec :: Int -> ReadS SeekMode

readList :: ReadS [SeekMode]

readPrec :: ReadPrec SeekMode

readListPrec :: ReadPrec [SeekMode]

Show SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

showsPrec :: Int -> SeekMode -> ShowS

show :: SeekMode -> String

showList :: [SeekMode] -> ShowS

Condense SeekMode

Defined in System.FS.API.Types

Methods

condense :: SeekMode -> String

Eq SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

(==) :: SeekMode -> SeekMode -> Bool

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

Ord SeekMode

Since: base-4.2.0.0

Defined in GHC.IO.Device

Methods

compare :: SeekMode -> SeekMode -> Ordering

(<) :: SeekMode -> SeekMode -> Bool

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

(>) :: SeekMode -> SeekMode -> Bool

(>=) :: SeekMode -> SeekMode -> Bool

max :: SeekMode -> SeekMode -> SeekMode

min :: SeekMode -> SeekMode -> SeekMode

allowExisting :: OpenMode -> AllowExisting

Paths

newtype MountPoint

Mount point

FsPaths are not absolute paths, but must be interpreted with respect to a particualar mount point.

Constructors

MountPoint FilePath

fsFromFilePath :: MountPoint -> FilePath -> Maybe FsPath

fsPathFromList :: [Text] -> FsPath

Create a path from a list of directory/file names. All of the names should be non-empty.

fsPathInit :: HasCallStack => FsPath -> FsPath

Drop the final component of the path

Undefined if the path is empty.

fsPathSplit :: FsPath -> Maybe (FsPath, Text)

Split FsPath is essentially (init fp, last fp)

Like init and last, Nothing if empty.

fsPathToList :: FsPath -> [Text]

fsToFilePath :: MountPoint -> FsPath -> FilePath

mkFsPath :: [String] -> FsPath

Constructor for FsPath ensures path is in normal form

(<.>) :: FsPath -> String -> FsPath infixr 7

Add an extension, even if there is already one there.

This works similarly to <.>.

addExtension :: FsPath -> String -> FsPath

An alias for <.>.

(</>) :: FsPath -> FsPath -> FsPath infixr 5

Combine two paths with a path separator.

This works similarly to </>, but since the arguments are relative paths, the corner cases for </> do not apply. Specifically, the second path will never start with a path separator or a drive letter, so the result is simply the concatenation of the two paths.

If either operand is empty, the other operand is returned. The result of combining two empty paths is the empty path

combine :: FsPath -> FsPath -> FsPath

An alias for </>.

opaque

data FsPath

A relative path.

Invariant

The user of this library is tasked with picking sensible names of directories/files on a path. Amongst others, the following should hold:

• Names are non-empty
• Names are monotonic, i.e., they are not equal to ..
• Names should not contain path separators or drive letters

In particular, names that satisfy these invariants should result in an FsPath that remains relative to the HasFS instance root. For example, an FsPath ["/"] would try to access the root folder, which is most likely outside of the scope of the HasFS instance.

".." should not be used because fs-sim will not be able to follow these types of back-links. fs-sim will interpret ".." as a directory name instead.

Instances

Generic FsPath

Defined in System.FS.API.Types

Associated Types

type Rep FsPath :: Type -> Type

Methods

from :: FsPath -> Rep FsPath x

to :: Rep FsPath x -> FsPath

Show FsPath

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> FsPath -> ShowS

show :: FsPath -> String

showList :: [FsPath] -> ShowS

NFData FsPath

Defined in System.FS.API.Types

Methods

rnf :: FsPath -> ()

Condense FsPath

Defined in System.FS.API.Types

Methods

condense :: FsPath -> String

Eq FsPath

Defined in System.FS.API.Types

Methods

(==) :: FsPath -> FsPath -> Bool

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

Ord FsPath

Defined in System.FS.API.Types

Methods

compare :: FsPath -> FsPath -> Ordering

(<) :: FsPath -> FsPath -> Bool

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

(>) :: FsPath -> FsPath -> Bool

(>=) :: FsPath -> FsPath -> Bool

max :: FsPath -> FsPath -> FsPath

min :: FsPath -> FsPath -> FsPath

type Rep FsPath

Defined in System.FS.API.Types

type Rep FsPath = D1 ('MetaData "FsPath" "System.FS.API.Types" "fs-api-0.3.0.0-9Af060UItM4vLHAUAXnQ0" 'True) (C1 ('MetaCons "UnsafeFsPath" 'PrefixI 'True) (S1 ('MetaSel ('Just "fsPathToList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

Handles

data Handle h

Constructors

Handle

Fields

• handleRaw :: !h

  The raw underlying handle

• handlePath :: !FsPath

  The path corresponding to this handle

  This is primarily useful for error reporting.

Instances

Generic (Handle h)

Defined in System.FS.API.Types

Associated Types

type Rep (Handle h) :: Type -> Type

Methods

from :: Handle h -> Rep (Handle h) x

to :: Rep (Handle h) x -> Handle h

Show (Handle h)

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> Handle h -> ShowS

show :: Handle h -> String

showList :: [Handle h] -> ShowS

NFData h => NFData (Handle h)

Defined in System.FS.API.Types

Methods

rnf :: Handle h -> ()

Condense (Handle h)

Defined in System.FS.API.Types

Methods

condense :: Handle h -> String

Eq h => Eq (Handle h)

Defined in System.FS.API.Types

Methods

(==) :: Handle h -> Handle h -> Bool

(/=) :: Handle h -> Handle h -> Bool

type Rep (Handle h)

Defined in System.FS.API.Types

type Rep (Handle h) = D1 ('MetaData "Handle" "System.FS.API.Types" "fs-api-0.3.0.0-9Af060UItM4vLHAUAXnQ0" 'False) (C1 ('MetaCons "Handle" 'PrefixI 'True) (S1 ('MetaSel ('Just "handleRaw") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 h) :*: S1 ('MetaSel ('Just "handlePath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FsPath)))

Offset

newtype AbsOffset

Constructors

AbsOffset

Fields

• unAbsOffset :: Word64

Instances

Bounded AbsOffset

Defined in System.FS.API.Types

Methods

minBound :: AbsOffset

maxBound :: AbsOffset

Enum AbsOffset

Defined in System.FS.API.Types

Methods

succ :: AbsOffset -> AbsOffset

pred :: AbsOffset -> AbsOffset

toEnum :: Int -> AbsOffset

fromEnum :: AbsOffset -> Int

enumFrom :: AbsOffset -> [AbsOffset]

enumFromThen :: AbsOffset -> AbsOffset -> [AbsOffset]

enumFromTo :: AbsOffset -> AbsOffset -> [AbsOffset]

enumFromThenTo :: AbsOffset -> AbsOffset -> AbsOffset -> [AbsOffset]

Num AbsOffset

Defined in System.FS.API.Types

Methods

(+) :: AbsOffset -> AbsOffset -> AbsOffset

(-) :: AbsOffset -> AbsOffset -> AbsOffset

(*) :: AbsOffset -> AbsOffset -> AbsOffset

negate :: AbsOffset -> AbsOffset

abs :: AbsOffset -> AbsOffset

signum :: AbsOffset -> AbsOffset

fromInteger :: Integer -> AbsOffset

Show AbsOffset

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> AbsOffset -> ShowS

show :: AbsOffset -> String

showList :: [AbsOffset] -> ShowS

Eq AbsOffset

Defined in System.FS.API.Types

Methods

(==) :: AbsOffset -> AbsOffset -> Bool

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

Ord AbsOffset

Defined in System.FS.API.Types

Methods

compare :: AbsOffset -> AbsOffset -> Ordering

(<) :: AbsOffset -> AbsOffset -> Bool

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

(>) :: AbsOffset -> AbsOffset -> Bool

(>=) :: AbsOffset -> AbsOffset -> Bool

max :: AbsOffset -> AbsOffset -> AbsOffset

min :: AbsOffset -> AbsOffset -> AbsOffset

Errors

data FsError

Constructors

FsError

Fields

• fsErrorType :: FsErrorType

  Error type

• fsErrorPath :: FsErrorPath

  Path to the file

• fsErrorString :: String

  Human-readable string giving additional information about the error

• fsErrorNo :: Maybe Errno

  The Errno, if available. This is more precise than the FsErrorType.

• fsErrorStack :: PrettyCallStack

  Call stack

• fsLimitation :: Bool

  Is this error due to a limitation of the mock file system?

  The mock file system does not all of Posix's features and quirks. This flag will be set for such unsupported IO calls. Real I/O calls would not have thrown an error for these calls.

Instances

Exception FsError

Defined in System.FS.API.Types

Methods

toException :: FsError -> SomeException

fromException :: SomeException -> Maybe FsError

displayException :: FsError -> String

Show FsError

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> FsError -> ShowS

show :: FsError -> String

showList :: [FsError] -> ShowS

data FsErrorPath

For better error reporting to the end user, we want to include the mount point of the file. But the mountpoint may not always be available, like when we mock the fs or we simulate fs errors.

Constructors

FsErrorPath (Maybe MountPoint) FsPath

Instances

Show FsErrorPath

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> FsErrorPath -> ShowS

show :: FsErrorPath -> String

showList :: [FsErrorPath] -> ShowS

Condense FsErrorPath

Defined in System.FS.API.Types

Methods

condense :: FsErrorPath -> String

Eq FsErrorPath

We only care to compare the FsPath, because the MountPoint may not exist.

Defined in System.FS.API.Types

Methods

(==) :: FsErrorPath -> FsErrorPath -> Bool

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

data FsErrorType

Constructors

FsIllegalOperation

FsResourceInappropriateType

e.g the user tried to open a directory with hOpen rather than a file.

FsResourceAlreadyInUse

FsResourceDoesNotExist

FsResourceAlreadyExist

FsReachedEOF

FsDeviceFull

FsTooManyOpenFiles

FsInsufficientPermissions

FsInvalidArgument

FsOther

Used for all other error types

Instances

Show FsErrorType

Defined in System.FS.API.Types

Methods

showsPrec :: Int -> FsErrorType -> ShowS

show :: FsErrorType -> String

showList :: [FsErrorType] -> ShowS

Eq FsErrorType

Defined in System.FS.API.Types

Methods

(==) :: FsErrorType -> FsErrorType -> Bool

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

fsToFsErrorPath :: MountPoint -> FsPath -> FsErrorPath

fsToFsErrorPathUnmounted :: FsPath -> FsErrorPath

Like fsToFsErrorPath, but when we don't have a MountPoint

hasMountPoint :: FsError -> Bool

isFsErrorType :: FsErrorType -> FsError -> Bool

prettyFsError :: FsError -> String

sameFsError :: FsError -> FsError -> Bool

Check if two errors are semantically the same error

This ignores the error string, the errno, and the callstack.

From IOError to FsError

ioToFsError :: HasCallStack => FsErrorPath -> IOError -> FsError

Translate exceptions thrown by IO functions to FsError

We take the FsPath as an argument. We could try to translate back from a FilePath to an FsPath (given a MountPoint), but we know the FsPath at all times anyway and not all IO exceptions actually include a filepath.

ioToFsErrorType :: IOError -> FsErrorType

Assign an FsErrorType to the given IOError.

Note that we don't always use the classification made by errnoToIOError (also see Error) because it combines some errors into one IOErrorType, e.g., EMFILE (too many open files) and ENOSPC (no space left on device) both result in ResourceExhausted while we want to keep them separate. For this reason, we do a classification of our own based on the errno while sometimes deferring to the existing classification.

See the ERRNO(3) man page for the meaning of the different errnos.

Orphan instances

Condense SeekMode

Methods

condense :: SeekMode -> String