package multibase

You can search for identifiers within the package.

in-package search v0.2.0

package multibase

multibase
- Multibase
  - Base32
    
    I63
  - Base58
    
    Alphabet
    
    Util
  - Encoding
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Encoding : sig ... end

module Base58 : sig ... end

module Base32 : sig ... end

type t = [

| `Base32
| `Base32hex
| `Base32hexpad
| `Base32hexupper
| `Base32hexpadupper
| `Base32pad
| `Base32upper
| `Base58btc
| `Base58flickr
| `Base64
| `Base64pad
| `Base64url
| `Base64urlpad

]

module type S = sig ... end

include S with type t := t

val encode_t : t -> string -> (string, [ `Msg of string ]) Stdlib.result

encode_t kind s encodes s using base-encoding sheme kind.

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

Similiar to encode_t except it may return `Unsupported kind

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

decode s will try to decode the multibase string s returning the encoding scheme and the decoded payload. It may be the case that we found a scheme we don't support.