package multicodec

All checked builds pass
  1. Overview
  2. Docs
Canonical codec of values and types used by various multiformats

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

  1. P
    patrick@sirref.org

Maintainers

  1. P
    patrick@sirref.org

Sources

multicodec-0.1.0.tbz
sha256=56aeb4ea2d2a8a473c4d75a83e119bf1151636cd3f469ea29f179810e40b22cb
sha512=c933b19b437dc87e455b4b7e94f29953bc8b52bcb10f49dec4b614d9261560e6d7ce82a5b577ab99278238550b38f2e480d048339e868b592e9cf337fdf5ba29

Description

This library provides OCaml types and values for multicodec.

Added to opam-repository:

README

ocaml-multicodec

This library provides OCaml values and types derived from the mutlicodec definition.

# #require "multicodec";;

Multicodec is an agreed upon codec table, essentially providing a means to encode some value as a number. For example, a number for hashes that are generated with SHA256.

# Multicodec.multihash_to_code;;
- : Multicodec.multihash -> int = <fun>
# Multicodec.multihash_to_code `Sha2_256;;
- : int = 18
# Multicodec.multihash_of_code 18;;
- : Multicodec.multihash option = Some `Sha2_256

Other encoded values include common addressing schemes, such as DNS.

# Multicodec.multiaddr_to_code `Dns;;
- : int = 53

Find out more about multicodec at the multiformats websites.

Dependencies (2)

  1. dune >= "2.9"
  2. ocaml >= "4.03.0"

Dev Dependencies (2)

  1. odoc with-doc
  2. mdx with-test

Optional Dependencies

None

Used by (2)

  1. cid
  2. multihash

Conflicts

None

Build status

Results of building multicodec with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.1.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure