Tahoe.CHK.URIExtension

Documentation

data URIExtension

Represent additional metadata that appears at the end of each share.

Constructors

URIExtension

Fields

• _codecName :: ByteString

  The name of the encoding function. Only "zfec" is implemented.

• _codecParams :: Parameters

  The parameters for the encoding function for all except the final segment.

• _tailCodecParams :: Parameters

  The parameters for the encoding function for the final segment.

• _size :: Size

  The application data size in bytes.

• _segmentSize :: Size

  The individual segment size in bytes.

• _numSegments :: SegmentNum

  The number of segments of application data. Note the last segment may be short so it is not necessarily the case that uriExtSize == uriExtSegmentSize * uriExtNumSegments.

• _neededShares :: Required

  The required (K) parameter to the encoding function. This is a duplicate of the values in uriExtCodecParams and uriExtTailCodecParams.

• _totalShares :: Total

  The total (N) parameter to the encoding function. This too is a duplicate.

• _crypttextHash :: CrypttextHash SHA256d

  A tagged sha256d hash of the complete ciphertext.

• _crypttextRootHash :: CrypttextHash SHA256d

  The root hash of a merkle tree where the leaf hashes are of segments of ciphertext.

• _shareRootHash :: CrypttextHash SHA256d

  The root hash of a merkle tree where leaf hashes are the root hashes of all of the block hash trees.

Instances

Eq URIExtension

Defined in Tahoe.CHK.URIExtension

Methods

(==) :: URIExtension -> URIExtension -> Bool

(/=) :: URIExtension -> URIExtension -> Bool

Ord URIExtension

Defined in Tahoe.CHK.URIExtension

Methods

compare :: URIExtension -> URIExtension -> Ordering

(<) :: URIExtension -> URIExtension -> Bool

(<=) :: URIExtension -> URIExtension -> Bool

(>) :: URIExtension -> URIExtension -> Bool

(>=) :: URIExtension -> URIExtension -> Bool

max :: URIExtension -> URIExtension -> URIExtension

min :: URIExtension -> URIExtension -> URIExtension

Show URIExtension

Defined in Tahoe.CHK.URIExtension

Methods

showsPrec :: Int -> URIExtension -> ShowS

show :: URIExtension -> String

showList :: [URIExtension] -> ShowS

Generic URIExtension

Defined in Tahoe.CHK.URIExtension

Associated Types

type Rep URIExtension :: Type -> Type

Methods

from :: URIExtension -> Rep URIExtension x

to :: Rep URIExtension x -> URIExtension

ToExpr URIExtension

Defined in Tahoe.CHK.URIExtension

Methods

toExpr :: URIExtension -> Expr

listToExpr :: [URIExtension] -> Expr

type Rep URIExtension

Defined in Tahoe.CHK.URIExtension

type Rep URIExtension = D1 ('MetaData "URIExtension" "Tahoe.CHK.URIExtension" "tahoe-chk-0.2.0.0-inplace" 'False) (C1 ('MetaCons "URIExtension" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_codecName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "_codecParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Parameters)) :*: (S1 ('MetaSel ('Just "_tailCodecParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Parameters) :*: (S1 ('MetaSel ('Just "_size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Size) :*: S1 ('MetaSel ('Just "_segmentSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Size)))) :*: ((S1 ('MetaSel ('Just "_numSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SegmentNum) :*: (S1 ('MetaSel ('Just "_neededShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Required) :*: S1 ('MetaSel ('Just "_totalShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Total))) :*: (S1 ('MetaSel ('Just "_crypttextHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CrypttextHash SHA256d)) :*: (S1 ('MetaSel ('Just "_crypttextRootHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CrypttextHash SHA256d)) :*: S1 ('MetaSel ('Just "_shareRootHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CrypttextHash SHA256d)))))))

codecName :: Lens' URIExtension ByteString

codecParams :: Lens' URIExtension Parameters

tailCodecParams :: Lens' URIExtension Parameters

size :: Lens' URIExtension Size

segmentSize :: Lens' URIExtension Size

numSegments :: Lens' URIExtension SegmentNum

neededShares :: Lens' URIExtension Required

totalShares :: Lens' URIExtension Total

crypttextHash :: Lens' URIExtension (CrypttextHash SHA256d)

crypttextRootHash :: Lens' URIExtension (CrypttextHash SHA256d)

shareRootHash :: Lens' URIExtension (CrypttextHash SHA256d)

uriExtensionToBytes :: URIExtension -> ByteString

showBytes :: Show s => s -> ByteString

Show a value as a UTF-8-encoded byte string.

pURIExtension :: Parser URIExtension

Parse the representation of a URIExtension which appears in CHK shares back into a URIExtension.