Safe Haskell	Safe-Inferred
Language	GHC2021

Charon.Backend.Fdo.PathData

Contents

PathData

Description

Provides PathData for use with the FreeDesktopOrg backend.

Synopsis

data PathData = UnsafePathData {
- fileName :: PathI TrashEntryFileName
- originalPath :: PathI TrashEntryOriginalPath
- created :: Timestamp
}
toPathData :: (HasCallStack, MonadCatch m, MonadLoggerNS m, MonadPathReader m) => Timestamp -> PathI TrashHome -> PathI TrashEntryOriginalPath -> m (PathData, PathTypeW)
toCorePathData :: (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadPathReader m, MonadPosixCompat m, MonadTerminal m) => PathI TrashHome -> PathData -> m PathData
toCorePathDataDirectorySizes :: (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadPathReader m, MonadPosixCompat m, MonadTerminal m) => HashMap ByteString DirectorySizesEntry -> PathI TrashHome -> PathData -> m PathData
fromCorePathData :: PathData -> PathData

PathData

data PathData Source #

Data for an Fdo path. Maintains an invariant that the original path is not the root nor is it empty.

Constructors

UnsafePathData
Fields fileName :: PathI TrashEntryFileName The path to be used in the trash directory. originalPath :: PathI TrashEntryOriginalPath The original path on the file system. created :: Timestamp Time this entry was created.

Instances

Instances details

Generic PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Associated Types type Rep PathData :: Type -> Type # Methods from :: PathData -> Rep PathData x # to :: Rep PathData x -> PathData #
Show PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods showsPrec :: Int -> PathData -> ShowS # show :: PathData -> String # showList :: [PathData] -> ShowS #
Serial PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Associated Types type DecodeExtra PathData Source # Methods encode :: PathData -> Either String ByteString Source # decode :: DecodeExtra PathData -> ByteString -> Either String PathData Source #
NFData PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods rnf :: PathData -> () #
Eq PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods (==) :: PathData -> PathData -> Bool # (/=) :: PathData -> PathData -> Bool #
Hashable PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods hashWithSalt :: Int -> PathData -> Int Source # hash :: PathData -> Int Source #
(k ~ A_Lens, a ~ Timestamp, b ~ Timestamp) => LabelOptic "created" k PathData PathData a b Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ PathI 'TrashEntryFileName, b ~ PathI 'TrashEntryFileName) => LabelOptic "fileName" k PathData PathData a b Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ PathI 'TrashEntryOriginalPath, b ~ PathI 'TrashEntryOriginalPath) => LabelOptic "originalPath" k PathData PathData a b Source #
Instance details Defined in Charon.Backend.Fdo.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
type Rep PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData type Rep PathData = D1 ('MetaData "PathData" "Charon.Backend.Fdo.PathData" "charon-0.1-inplace" 'False) (C1 ('MetaCons "UnsafePathData" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PathI 'TrashEntryFileName)) :: (S1 ('MetaSel ('Just "originalPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PathI 'TrashEntryOriginalPath)) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Timestamp))))
type DecodeExtra PathData Source #
Instance details Defined in Charon.Backend.Fdo.PathData type DecodeExtra PathData = PathI 'TrashEntryFileName

toPathData :: (HasCallStack, MonadCatch m, MonadLoggerNS m, MonadPathReader m) => Timestamp -> PathI TrashHome -> PathI TrashEntryOriginalPath -> m (PathData, PathTypeW) Source #

For a given filepath, attempts to capture the following data:

Canonical path.
Unique name to be used in the trash directory.
File/directory type.

toCorePathData :: (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadPathReader m, MonadPosixCompat m, MonadTerminal m) => PathI TrashHome -> PathData -> m PathData Source #

toCorePathDataDirectorySizes :: (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadPathReader m, MonadPosixCompat m, MonadTerminal m) => HashMap ByteString DirectorySizesEntry -> PathI TrashHome -> PathData -> m PathData Source #

fromCorePathData :: PathData -> PathData Source #