package cid

  1. Overview
  2. Docs
package cid
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type S = sig ... end
module Make (H : Multihash.S) : S with type multihash = Cstruct.t H.t
include S with type multihash = Cstruct.t Multihash_digestif.t

The type for multihashes

type t

A content-addressed identifier.

val v : version:[ `Cidv0 | `Cidv1 | `Cidv2 | `Cidv3 ] -> base:Multibase.Encoding.t -> codec:Multicodec.t -> hash:multihash -> t

Build a CID, this performs no checks on any of the inputs

val version : t -> [ `Cidv0 | `Cidv1 | `Cidv2 | `Cidv3 ]

The CID version.

val base : t -> Multibase.Encoding.t

The multibase encoding of the CID.

val codec : t -> Multicodec.t

The multicodec type of the data

val hash : t -> multihash

The multihash of the CID

val equal : t -> t -> bool

Tests the equality of two CIDs.

val of_string : string -> (t, [ `Msg of string | `Unsupported of Multibase.Encoding.t ]) Stdlib.result

of_string s takes an encoded string s that is the CID and pulls out each of the parts that make it up.

val of_cstruct : base:Multibase.Encoding.t -> Cstruct.t -> (t, [ `Msg of string | `Unsupported of Multibase.Encoding.t ]) Stdlib.result

of_cstruct ~base buf builds a value representing a CID. The buffer should not be encoded with the multibase encoding.

val to_string : t -> string

to_string t converts the CID to a multibase encoded string. Errors happen if the base encoding is not supported. This may raise an exception of the base encoding format is not supported.

val to_cstruct : t -> Cstruct.t

to_cstruct t returns a buffer with the bytes corresponding to the unencoded CID.

val pp_human : Stdlib.Format.formatter -> t -> unit

Pretty-prints a CID.