PFile.TrashCan

Types and functions for trashing filesystem's objects.

Documentation

create :: (MonadError CreateError m, MonadIO m) => m TrashCan

Create a new trash can.

Since: 0.1.0.0

showCreateError :: CreateError -> Text

data CreateError

Error thrown by create.

Since: 0.1.0.0

Constructors

TemporaryDirectoryResolveError !IOException

IOException was encountered during temporary directory resolving.

TemporaryDirectoryCreateError !Absolute !IOException

IOException was encountered during temporary directory creation.

trash :: (MonadError TrashError m, MonadIO m) => Absolute -> TrashCan -> m ()

mount Absolute inside of a TrashCan with CopyLink strategy for links.

Since: 0.1.0.0

showTrashError :: TrashError -> Text

data TrashError

Error thrown by trash.

Since: 0.1.0.0

Constructors

AlreadyTrashedError !Absolute !TrashCan

Absolute is already trashed.

MountError !MountError

Error was encountered during mount.

restoreAll :: (MonadWriter [RestoreEntryError] m, MonadIO m) => TrashCan -> m ()

restore all trashed filesystem's objects back to their original locations. When an error is encountered during restore, restoreAll terminates and provides successfully restoreed entries via a MonadWriter.

Since: 0.1.0.0

restore :: (MonadError RestoreError m, MonadIO m) => TrashCan -> Absolute -> m ()

unmount Absolute (turned into Mount) from a TrashCan back to its original location (before trash).

Since: 0.1.0.0

showRestoreEntryError :: RestoreEntryError -> Text

data RestoreEntryError

Error provided via MonadWriter by restoreAll.

Since: 0.1.0.0

Constructors

RestoreEntryError !Absolute !RestoreError

Error was encountered during restore.

showRestoreError :: RestoreError -> Text

newtype RestoreError

Error thrown by restore.

Since: 0.1.0.0

Constructors

UnmountError UnmountError

Error was encountered during unmount.

remove :: (MonadError RemoveError m, MonadIO m) => TrashCan -> m ()

Remove a TrashCan forcibly.

Since: 0.1.0.0

showRemoveError :: RemoveError -> Text

newtype RemoveError

Error thrown by remove.

Since: 0.1.0.0

Constructors

TemporaryDirectoryRemoveError RemoveError

Error was encountered during temporary directory removal.

dumpTrashed :: (MonadError DumpTrashedError m, MonadIO m) => TrashCan -> m Absolute

Dump trashed to a file inside of the root directory.

Since: 0.1.0.0

showDumpTrashedError :: DumpTrashedError -> Text

newtype DumpTrashedError

Error thrown by dumpTrashed.

Since: 0.1.0.0

Constructors

DumpTrashedError WriteFileError

Error was encountered during writing to a "trashed.txt" file inside of the root directory.

trashed :: MonadIO m => TrashCan -> m [Absolute]

List of trashed filesystem's objects.

Since: 0.1.0.0

data TrashCan

Trash can for filesystem's objects.

Since: 0.1.0.0

Constructors

TrashCan !Absolute !Absolute !(IORef [Absolute])