One or more string elements that together represent the path and filename. Each element in the list corresponds to either a directory name or (in the case of the last element) the filename. For example, the file:

 "dir1/dir2/file.ext"

would consist of three string elements:

 ["dir1", "dir2", "file.ext"]

Instances

Functor FileInfo
Typeable1 FileInfo
F.Foldable FileInfo
Eq a => Eq (FileInfo a)
Read a => Read (FileInfo a)
Show a => Show (FileInfo a)
ToJSON a0 => ToJSON (FileInfo a0)
FromJSON a0 => FromJSON (FileInfo a0)
NFData a => NFData (FileInfo a)
Pretty (FileInfo BS.ByteString)
BEncode (FileInfo [BS.ByteString])
BEncode (FileInfo BS.ByteString)

Lens

fileLength :: forall a. Lens' (FileInfo a) FileSize Source

filePath :: forall a a. Lens (FileInfo a) (FileInfo a) a aSource

fileMD5Sum :: forall a. Lens' (FileInfo a) (Maybe BS.ByteString)Source

File layout

data LayoutInfo Source

Original (found in torrent file) layout info is either:

Single file with its name.
Multiple files with its relative file paths.

Constructors

SingleFile
Fields liFile :: !(FileInfo BS.ByteString) Single file info.
MultiFile
Fields liFiles :: ![FileInfo [BS.ByteString]] List of the all files that torrent contains. liDirName :: !BS.ByteString The suggested name of the root directory in which to store all the files.

Instances

Eq LayoutInfo
Read LayoutInfo
Show LayoutInfo
Typeable LayoutInfo
ToJSON LayoutInfo
FromJSON LayoutInfo
NFData LayoutInfo
Pretty LayoutInfo
BEncode LayoutInfo

joinFilePath :: FileInfo [BS.ByteString] -> FileInfo BS.ByteString Source

Join file path.

Lens

singleFile :: Traversal' LayoutInfo (FileInfo BS.ByteString)Source

multiFile :: Traversal' LayoutInfo [FileInfo [BS.ByteString]]Source

rootDirName :: Traversal' LayoutInfo BS.ByteString Source

Predicates

isSingleFile :: LayoutInfo -> Bool Source

Test if this is single file torrent.

isMultiFile :: LayoutInfo -> Bool Source

Test if this is multifile torrent.

Query

Get name of the torrent based on the root path piece.

contentLength :: LayoutInfo -> FileSize Source

Find sum of sizes of the all torrent files.

fileCount :: LayoutInfo -> Int Source

Get number of all files in torrent.

blockCount :: BlockSize -> LayoutInfo -> Int Source

Find number of blocks of the specified size. If torrent size is not a multiple of block size then the count is rounded up.

Flat file layout

type Layout a = [(FilePath, a)]Source

File layout specifies the order and the size of each file in the storage. Note that order of files is highly important since we coalesce all the files in the given order to get the linear block address space.

flatLayout Source

Arguments

:: FilePath	Root path for the all torrent files.
-> LayoutInfo	Torrent content information.
-> Layout FileSize	The all file paths prefixed with the given root.

Extract files layout from torrent info with the given root path.

accumOffsets :: Layout FileSize -> Layout FileOffset Source

Calculate offset of each file based on its length, incrementally.

fileOffset :: FilePath -> Layout FileOffset -> Maybe FileOffset Source

Gives global offset of a content file for a given full path.

Internal

getLayoutInfo :: Get LayoutInfo Source

putLayoutInfo :: Put LayoutInfo Source