package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.0.tar.gz

sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c

sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-libs.rpc/Tezos_rpc/Query/index.html

Module `Tezos_rpc.Query`Source

include module type of struct include Resto.Query end

Sourcetype 'a t = 'a Resto.Query.t

A type for representing query parameters.

Sourcetype 'a query = 'a t

Sourceval empty : unit query

empty is for services that expects no query parameters.

Sourcetype ('a, 'b) field = ('a, 'b) Resto.Query.field

The type for key-value pairs that constitute a query. The first type parameter is for whole-query store and the second is for the type of value carried by the field.

Source

val field : 
  ?descr:string ->
  string ->
  'a Resto.Arg.t ->
  'a ->
  ('b -> 'a) ->
  ('b, 'a) field

field ?descr key arg default get is a field for the query parameters, i.e., it describes one key-value pair.

The key is given by key and the value is parsed as specified in arg or, if absent from the URI suffix, default.

Finally, get is for retrieving the value from the whole-query store. More on the whole-query store below.

Source

val opt_field : 
  ?descr:string ->
  string ->
  'a Resto.Arg.t ->
  ('b -> 'a option) ->
  ('b, 'a option) field

Sourceval flag : ?descr:string -> string -> ('b -> bool) -> ('b, bool) field

Source

val multi_field : 
  ?descr:string ->
  string ->
  'a Resto.Arg.t ->
  ('b -> 'a list) ->
  ('b, 'a list) field

Sourcetype ('a, 'b, 'c) open_query = ('a, 'b, 'c) Resto.Query.open_query

Queries are constructed by adding fields to an open query and sealing it into a query. This is done using the functions below. Typically, it is done as follow: query c |+ field1 |+ field2 |> seal

As the types require, you must provide the correct argument to the successive building steps. Here is an example: query (fun timeout shade -> (timeout, shade)) |+ field "timeout" Arg.float 10. (fun (timeout, _) -> timeout) |+ field "shade" Arg.string "fuchsia" (fun (_, shade) -> shade) |> seal

The initial query function takes a whole-query store builder (a function that assemble all the fields into a single store of values), and each field takes a function to recover the value from the whole-query store.

Sourceval query : 'b -> ('a, 'b, 'b) open_query

Source

val (|+) : 
  ('a, 'b, 'c -> 'd) open_query ->
  ('a, 'c) field ->
  ('a, 'b, 'd) open_query

Sourceval seal : ('a, 'b, 'a) open_query -> 'a t

package octez-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-libs.rpc/Tezos_rpc/Query/index.html

Module Tezos_rpc.QuerySource

Module `Tezos_rpc.Query`Source