Skip to content

Commit fff21ff

Browse files
jorisdraljorisdral
committed
Add deprecation warnings
1 parent 552897c commit fff21ff

File tree

14 files changed

+241
-3
lines changed

14 files changed

+241
-3
lines changed

‎ouroboros-consensus-test/ouroboros-consensus-test.cabal‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ library
4242
Test.Util.Classify
4343
Test.Util.Corruption
4444
Test.Util.FileLock
45+
Test.Util.FS.Sim.Error
46+
Test.Util.FS.Sim.FsTree
47+
Test.Util.FS.Sim.MockFS
48+
Test.Util.FS.Sim.Pure
49+
Test.Util.FS.Sim.STM
4550
Test.Util.HardFork.Future
4651
Test.Util.HardFork.OracularClock
4752
Test.Util.InvertedMap
@@ -255,7 +260,6 @@ test-suite test-storage
255260
, cborg
256261
, containers
257262
, contra-tracer
258-
, directory
259263
, generics-sop
260264
, hashable
261265
, mtl
@@ -268,7 +272,6 @@ test-suite test-storage
268272
, tasty
269273
, tasty-hunit
270274
, tasty-quickcheck
271-
, temporary
272275
, text
273276
, time
274277
, tree-diff

‎ouroboros-consensus-test/src/Test/Util/FS/Sim/Error.hs‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
module Test.Util.FS.Sim.Error {-# DEPRECATED "Use System.FS.Sim.Error from fs-sim" #-} (
2+
-- * Simulate Errors monad
3+
mkSimErrorHasFS
4+
, runSimErrorFS
5+
, withErrors
6+
-- * Streams
7+
, ErrorStream
8+
, ErrorStreamGetSome
9+
, ErrorStreamPutSome
10+
, Stream (..)
11+
, always
12+
, mkStream
13+
, mkStreamGen
14+
, null
15+
, runStream
16+
-- * Generating partial reads/writes
17+
, Partial (..)
18+
, hGetSomePartial
19+
, hPutSomePartial
20+
-- * Generating corruption for 'hPutSome'
21+
, PutCorruption (..)
22+
, corrupt
23+
-- * Error streams for 'HasFS'
24+
, Errors (..)
25+
, allNull
26+
, genErrors
27+
, simpleErrors
28+
) where
29+
30+
import Prelude hiding (null)
31+
32+
import System.FS.Sim.Error

‎ouroboros-consensus-test/src/Test/Util/FS/Sim/FsTree.hs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
module Test.Util.FS.Sim.FsTree {-# DEPRECATED "Use System.FS.Sim.FsTree from fs-sim" #-} (
2+
-- * FsTree type and indexing functions
3+
FsTree (..)
4+
, FsTreeError (..)
5+
, example
6+
-- * Construction
7+
, empty
8+
-- * Indexing
9+
, getDir
10+
, getFile
11+
, index
12+
-- * File system operations
13+
, createDirIfMissing
14+
, createDirWithParents
15+
, openFile
16+
, removeFile
17+
, renameFile
18+
, replace
19+
-- * Pretty-printing
20+
, pretty
21+
) where
22+
23+
import System.FS.Sim.FsTree

‎ouroboros-consensus-test/src/Test/Util/FS/Sim/MockFS.hs‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
module Test.Util.FS.Sim.MockFS {-# DEPRECATED "Use System.FS.Sim.MockFS from fs-sim" #-} (
2+
empty
3+
, example
4+
, handleIsOpen
5+
, numOpenHandles
6+
, pretty
7+
-- * Debugging
8+
, dumpState
9+
-- * Operations on files
10+
, hClose
11+
, hGetSize
12+
, hGetSome
13+
, hGetSomeAt
14+
, hIsOpen
15+
, hOpen
16+
, hPutSome
17+
, hSeek
18+
, hTruncate
19+
-- * Operations on directories
20+
, createDirectory
21+
, createDirectoryIfMissing
22+
, doesDirectoryExist
23+
, doesFileExist
24+
, listDirectory
25+
, removeFile
26+
, renameFile
27+
-- * Exported for the benefit of tests only
28+
, Files
29+
, mockFiles
30+
-- ** opaque
31+
, ClosedHandleState
32+
, FilePtr
33+
, HandleState
34+
, OpenHandleState
35+
-- * opaque
36+
, HandleMock
37+
, MockFS
38+
) where
39+
40+
import System.FS.Sim.MockFS

‎ouroboros-consensus-test/src/Test/Util/FS/Sim/Pure.hs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module Test.Util.FS.Sim.Pure {-# DEPRECATED "Use System.FS.Sim.Pure from fs-sim" #-}(
2+
PureSimFS
3+
-- opaque
4+
, pureHasFS
5+
, runPureSimFS
6+
) where
7+
8+
import System.FS.Sim.Pure

‎ouroboros-consensus-test/src/Test/Util/FS/Sim/STM.hs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module Test.Util.FS.Sim.STM {-# DEPRECATED "Use System.FS.Sim.STM from fs-sim" #-} (
2+
runSimFS
3+
, simHasFS
4+
) where
5+
6+
import System.FS.Sim.STM

‎ouroboros-consensus/ouroboros-consensus.cabal‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,12 @@ library
200200
Ouroboros.Consensus.Storage.ChainDB.Impl.Types
201201
Ouroboros.Consensus.Storage.ChainDB.Init
202202
Ouroboros.Consensus.Storage.Common
203+
Ouroboros.Consensus.Storage.FS.API
204+
Ouroboros.Consensus.Storage.FS.API.Types
205+
Ouroboros.Consensus.Storage.FS.CRC
206+
Ouroboros.Consensus.Storage.FS.Handle
207+
Ouroboros.Consensus.Storage.FS.IO
208+
Ouroboros.Consensus.Storage.IO
203209
Ouroboros.Consensus.Storage.ImmutableDB
204210
Ouroboros.Consensus.Storage.ImmutableDB.API
205211
Ouroboros.Consensus.Storage.ImmutableDB.Chunks

‎ouroboros-consensus/src/Ouroboros/Consensus/Storage/FS/API.hs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
module Ouroboros.Consensus.Storage.FS.API {-# DEPRECATED "Use System.FS.API from fs-api" #-} (
2+
Handle (..)
3+
, HasFS (..)
4+
, SomeHasFS (..)
5+
, hClose'
6+
, hGetAll
7+
, hGetAllAt
8+
, hGetExactly
9+
, hGetExactlyAt
10+
, hPut
11+
, hPutAll
12+
, hPutAllStrict
13+
, withFile
14+
) where
15+
16+
import System.FS.API

‎ouroboros-consensus/src/Ouroboros/Consensus/Storage/FS/API/Types.hs‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
module Ouroboros.Consensus.Storage.FS.API.Types {-# DEPRECATED "Use System.FS.API.Types from fs-api" #-} (
2+
-- * Modes
3+
AllowExisting (..)
4+
, OpenMode (..)
5+
, SeekMode (..)
6+
, allowExisting
7+
-- * Paths
8+
, MountPoint (..)
9+
, fsFromFilePath
10+
, fsPathFromList
11+
, fsPathInit
12+
, fsPathSplit
13+
, fsPathToList
14+
, fsToFilePath
15+
, mkFsPath
16+
-- ** opaque
17+
, FsPath
18+
-- * Handles
19+
, Handle (..)
20+
-- * Offset
21+
, AbsOffset (..)
22+
-- * Errors
23+
, FsError (..)
24+
, FsErrorPath (..)
25+
, FsErrorType (..)
26+
, fsToFsErrorPath
27+
, fsToFsErrorPathUnmounted
28+
, hasMountPoint
29+
, isFsErrorType
30+
, prettyFsError
31+
, sameFsError
32+
-- * From 'IOError' to 'FsError'
33+
, ioToFsError
34+
, ioToFsErrorType
35+
) where
36+
37+
import System.FS.API.Types

‎ouroboros-consensus/src/Ouroboros/Consensus/Storage/FS/CRC.hs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
module Ouroboros.Consensus.Storage.FS.CRC {-# DEPRECATED "Use System.FS.CRC from fs-api" #-} (
2+
-- * Wrap digest functionality
3+
CRC (..)
4+
, computeCRC
5+
, initCRC
6+
, updateCRC
7+
-- * File system functions with CRC functionality
8+
, hGetAllAtCRC
9+
, hGetExactlyAtCRC
10+
, hPutAllCRC
11+
) where
12+
13+
import System.FS.CRC

0 commit comments

Comments
 (0)