package octez-proto-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez protocol libraries

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V12/Make/Data_encoding/Bounded/index.html

Module `Data_encoding.Bounded`

val string : 
  ?length_kind:[ `N | `Uint30 | `Uint16 | `Uint8 ] ->
  string_json_repr ->
  int ->
  string encoding

Encoding of a string whose length does not exceed the specified length.

If length_kind is set, then it is used to encode the length of the string in a header. If length_kind is omitted then the length field uses the smallest fixed-width integer that can accommodate the maximum size - e.g., `Uint8 for very short strings, `Uint16 for longer strings, etc.

Attempting to construct a string with a length that is too long causes an Invalid_argument exception.

raises Invalid_argument
if length_kind is set but it cannot accommodate the specified bound. E.g., Bounded.string ~length_kind:`Uint8 Hex 1000 raises.

raises Invalid_argument
if length_kind is unset and the specified bound is larger than 2^30.

val bytes : 
  ?length_kind:[ `N | `Uint30 | `Uint16 | `Uint8 ] ->
  string_json_repr ->
  int ->
  Bytes.t encoding

See string above.