Data.Torrent.Block

Blocks are used to transfer pieces.

Piece attributes

type PieceIx = Int

Zero-based index of piece in torrent content.

type PieceSize = Int

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.

Block attributes

type BlockOffset = Int

Offset of a block in a piece in bytes. Should be multiple of the choosen block size.

type BlockCount = Int

Number of block in a piece of a torrent. Used to distinguish block count from piece count.

type BlockSize = Int

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

Normally block size is equal to defaultTransferSize.

defaultTransferSize :: BlockSize

Widely used semi-official block size. Some clients can ignore if block size of BlockIx in Request message is not equal to this value.

Block index

data BlockIx

BlockIx correspond.

Constructors

BlockIx

Fields

ixPiece :: !PieceIx

Zero-based piece index.

ixOffset :: !BlockOffset

Zero-based byte offset within the piece.

ixLength :: !BlockSize

Block size starting from offset.

Instances

Eq BlockIx

Show BlockIx

ToJSON BlockIx

FromJSON BlockIx

S.Serialize BlockIx

Pretty BlockIx

Binary BlockIx

blockIxRange :: (Num a, Integral a) => PieceSize -> BlockIx -> (a, a)

Get location of payload bytes in the torrent content.

Block data

data Block payload

Constructors

Block

Fields

blkPiece :: !PieceIx

Zero-based piece index.

blkOffset :: !BlockOffset

Zero-based byte offset within the piece.

blkData :: !payload

Payload bytes.

Instances

Eq payload => Eq (Block payload)

Show payload => Show (Block payload)

Pretty (Block Lazy.ByteString)

Payload is ommitted.

blockIx :: Block Lazy.ByteString -> BlockIx

Get block index of a block.

blockSize :: Block Lazy.ByteString -> BlockSize

Get size of block payload in bytes.

blockRange :: (Num a, Integral a) => PieceSize -> Block Lazy.ByteString -> (a, a)

Get location of payload bytes in the torrent content.