Portability	portable
Stability	experimental
Maintainer	pxqr.sta@gmail.com
Safe Haskell	None

Data.Torrent.Piece

Contents

Piece attributes
Piece data
Piece control
Lens
Validation
Internal

Description

Pieces are used to validate torrent content.

Synopsis

Piece attributes

type PieceIx = Int Source

Zero-based index of piece in torrent content.

type PieceCount = Int Source

Number of pieces in torrent or a part of torrent.

type PieceSize = Int Source

Size of piece in bytes. Should be a power of 2.

NOTE: Have max and min size constrained to wide used semi-standard values. This bounds should be used to make decision about piece size for new torrents.

minPieceSize :: Int Source

Piece size should not be less than this value.

maxPieceSize :: Int Source

To prevent transfer degradation piece size should not exceed this value.

defaultPieceSize :: Int64 -> Int Source

Find the optimal piece size for a given torrent size.

Piece data

data Piece a Source

Piece payload should be strict or lazy bytestring.

Constructors

Piece
Fields pieceIndex :: !PieceIx Zero-based piece index in torrent. pieceData :: !a Payload.

Instances

Typeable1 Piece
Eq a => Eq (Piece a)
Read a => Read (Piece a)
Show a => Show (Piece a)
ToJSON a0 => ToJSON (Piece a0)
FromJSON a0 => FromJSON (Piece a0)
NFData (Piece a)
Pretty (Piece a)	Payload bytes are omitted.

pieceSize :: Piece BL.ByteString -> PieceSize Source

Get size of piece in bytes.

isPiece :: PieceSize -> Block BL.ByteString -> Bool Source

Test if a block can be safely turned into a piece.

Piece control

newtype HashArray Source

A flat array of SHA1 sums of each piece.

Constructors

HashArray
Fields unHashArray :: BS.ByteString

Instances

Eq HashArray
Read HashArray
Show HashArray
ToJSON HashArray	Represented as base64 encoded JSON string.
FromJSON HashArray
BEncode HashArray

data PieceInfo Source

Part of torrent file used for torrent content validation.

Constructors

PieceInfo
Fields piPieceLength :: !PieceSize Number of bytes in each piece. piPieceHashes :: !HashArray Concatenation of all 20-byte SHA1 hash values.

Instances

Eq PieceInfo
Read PieceInfo
Show PieceInfo
Typeable PieceInfo
ToJSON PieceInfo
FromJSON PieceInfo
NFData PieceInfo
Pretty PieceInfo	Hashes are omitted.
BEncode PieceInfo

pieceCount :: PieceInfo -> PieceCount Source

Find count of pieces in the torrent. If torrent size is not a multiple of piece size then the count is rounded up.

Lens

pieceLength :: Lens' PieceInfo PieceSize Source

Number of bytes in each piece.

pieceHashes :: Lens' PieceInfo HashArray Source

Concatenation of all 20-byte SHA1 hash values.

Validation

pieceHash :: PieceInfo -> PieceIx -> BS.ByteString Source

Extract validation hash by specified piece index.

checkPieceLazy :: PieceInfo -> Piece BL.ByteString -> Bool Source

Validate piece with metainfo hash.

Internal

getPieceInfo :: Get PieceInfo Source

putPieceInfo :: PieceInfo -> BDict -> BDictSource