Data.IPLD.CID

Content IDentifiers

"CID is a format for referencing content in distributed information systems, like IPFS. It leverages content addressing, cryptographic hashing, and self-describing formats. It is the core identifier used by IPFS and IPLD."

Documentation

data Version

Specification version.

Constructors

V0

V1

Instances

Bounded Version

Defined in Data.IPLD.CID

Methods

minBound :: Version

maxBound :: Version

Enum Version

Defined in Data.IPLD.CID

Methods

succ :: Version -> Version

pred :: Version -> Version

toEnum :: Int -> Version

fromEnum :: Version -> Int

enumFrom :: Version -> [Version]

enumFromThen :: Version -> Version -> [Version]

enumFromTo :: Version -> Version -> [Version]

enumFromThenTo :: Version -> Version -> Version -> [Version]

Eq Version

Defined in Data.IPLD.CID

Methods

(==) :: Version -> Version -> Bool

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

Ord Version

Defined in Data.IPLD.CID

Methods

compare :: Version -> Version -> Ordering

(<) :: Version -> Version -> Bool

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

(>) :: Version -> Version -> Bool

(>=) :: Version -> Version -> Bool

max :: Version -> Version -> Version

min :: Version -> Version -> Version

Show Version

Defined in Data.IPLD.CID

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Generic Version

Defined in Data.IPLD.CID

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

Hashable Version

Defined in Data.IPLD.CID

Methods

hashWithSalt :: Int -> Version -> Int

hash :: Version -> Int

NFData Version

Defined in Data.IPLD.CID

Methods

rnf :: Version -> ()

type Rep Version

Defined in Data.IPLD.CID

type Rep Version = D1 (MetaData "Version" "Data.IPLD.CID" "ipld-cid-0.1.0.0-8NZ9ygnopa7DbdvMJP5n9H" False) (C1 (MetaCons "V0" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "V1" PrefixI False) (U1 :: Type -> Type))

data Codec

The content type or format of the data being addressed, specified as a multicodec.

Note that we do not currently have a full multicodec implementation, as it is overly complicated for our purposes. We also only support Codecs on an as-needed basis. Future versions may utilise a separate library.

Constructors

Raw

DagProtobuf

DagCbor

GitRaw

Instances

Eq Codec

Defined in Data.IPLD.CID

Methods

(==) :: Codec -> Codec -> Bool

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

Ord Codec

Defined in Data.IPLD.CID

Methods

compare :: Codec -> Codec -> Ordering

(<) :: Codec -> Codec -> Bool

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

(>) :: Codec -> Codec -> Bool

(>=) :: Codec -> Codec -> Bool

max :: Codec -> Codec -> Codec

min :: Codec -> Codec -> Codec

Show Codec

Defined in Data.IPLD.CID

Methods

showsPrec :: Int -> Codec -> ShowS

show :: Codec -> String

showList :: [Codec] -> ShowS

Generic Codec

Defined in Data.IPLD.CID

Associated Types

type Rep Codec :: Type -> Type

Methods

from :: Codec -> Rep Codec x

to :: Rep Codec x -> Codec

Hashable Codec

Defined in Data.IPLD.CID

Methods

hashWithSalt :: Int -> Codec -> Int

hash :: Codec -> Int

NFData Codec

Defined in Data.IPLD.CID

Methods

rnf :: Codec -> ()

type Rep Codec

Defined in Data.IPLD.CID

type Rep Codec = D1 (MetaData "Codec" "Data.IPLD.CID" "ipld-cid-0.1.0.0-8NZ9ygnopa7DbdvMJP5n9H" False) ((C1 (MetaCons "Raw" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DagProtobuf" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "DagCbor" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GitRaw" PrefixI False) (U1 :: Type -> Type)))

data CID

A Content IDentifier.

• V0 CIDs are merely SHA256 hashes, base58-encoded using the bitcoin alphabet. The Codec is implicitly DagProtobuf.
• V1 CIDs may use any Multihash, and any of the supported Codecs.

Instances

Eq CID

Defined in Data.IPLD.CID

Methods

(==) :: CID -> CID -> Bool

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

Ord CID

Defined in Data.IPLD.CID

Methods

compare :: CID -> CID -> Ordering

(<) :: CID -> CID -> Bool

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

(>) :: CID -> CID -> Bool

(>=) :: CID -> CID -> Bool

max :: CID -> CID -> CID

min :: CID -> CID -> CID

Read CID

Defined in Data.IPLD.CID

Methods

readsPrec :: Int -> ReadS CID

readList :: ReadS [CID]

readPrec :: ReadPrec CID

readListPrec :: ReadPrec [CID]

Show CID

Defined in Data.IPLD.CID

Methods

showsPrec :: Int -> CID -> ShowS

show :: CID -> String

showList :: [CID] -> ShowS

Generic CID

Defined in Data.IPLD.CID

Associated Types

type Rep CID :: Type -> Type

Methods

from :: CID -> Rep CID x

to :: Rep CID x -> CID

Hashable CID

Defined in Data.IPLD.CID

Methods

hashWithSalt :: Int -> CID -> Int

hash :: CID -> Int

NFData CID

Defined in Data.IPLD.CID

Methods

rnf :: CID -> ()

type Rep CID

Defined in Data.IPLD.CID

type Rep CID = D1 (MetaData "CID" "Data.IPLD.CID" "ipld-cid-0.1.0.0-8NZ9ygnopa7DbdvMJP5n9H" False) (C1 (MetaCons "CID" PrefixI True) (S1 (MetaSel (Just "cidVersion") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Version) :*: (S1 (MetaSel (Just "cidCodec") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Codec) :*: S1 (MetaSel (Just "cidHash") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Multihash))))

cidVersion :: CID -> Version

cidCodec :: CID -> Codec

cidHash :: CID -> Multihash

newCidV0 :: Digest SHA256 -> CID

Create a V0 CID.

newCidV1 :: Multihashable a => Codec -> Digest a -> CID

Create a V1 CID.

buildCid :: CID -> Builder

Serialise a CID.

decodeCid :: ByteString -> Either String CID

Decode a CID from a strict ByteString.

   decodeCid . buildCid ≡ Right

getCid :: Get CID

Deserialise a CID in the Get monad.

Note that this does not support V0 CIDs.

cidFromText :: Text -> Either String CID

Decode a CID from a textual representation.

The Text value is expected to be base58 (bitcoin) encoded (for V0 CIDs), or a valid Multibase.

   cidFromText . cidToText ≡ id

cidToText :: CID -> Text

Encode a CID to a textual representation.

The result is either a base58 (bitcoin) encoded string of just the cidHash value for V0 CIDs, or otherwise a Multibase value at base Base58btc of the binary representation of the CID (as produced by buildCid).

codecToCode :: Codec -> Word8

multicodec numerical code of the given Codec.

codecFromCode :: Word8 -> Maybe Codec

Attempt to convert from a multicodec numerical code to a Codec.