package capnp

  1. Overview
  2. Docs
package capnp
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

Signature

module RC : sig ... end
include module type of struct include RC end
module Segment = RC.Segment
module Message = RC.Message
module Slice = RC.Slice
module StructStorage = RC.StructStorage
module ListStorage = RC.ListStorage
module Object = RC.Object
val bounds_check_slice_exn : ?err:string -> 'cap Slice.t -> unit
val ss_get_pointer : ('cap, 'a) StructStorage.t -> int -> 'cap Slice.t option
val decode_pointer64 : int64 -> Capnp__.Pointer.t
val decode_pointer : 'cap Slice.t -> Capnp__.Pointer.t
val make_list_storage_aux : message:'a Message.t -> num_words:int -> num_elements:int -> storage_type:Capnp__.ListStorageType.t -> segment_id:int -> segment_offset:int -> 'a ListStorage.t
val make_list_storage : message:'cap Message.t -> segment_id:int -> segment_offset:int -> list_pointer:Capnp__.ListPointer.t -> 'cap ListStorage.t
val deref_far_pointer : Capnp__.FarPointer.t -> 'cap Message.t -> ('cap, 'a) Object.t
val deref_pointer : 'cap Slice.t -> ('cap, 'a) Object.t
module ListDecoders = RC.ListDecoders
module ListCodecs = RC.ListCodecs
val _dummy : bool ref
val make_array_readonly : 'cap ListStorage.t -> ('cap, 'a) ListDecoders.t -> (Message.ro, 'a, 'cap ListStorage.t) Capnp__.InnerArray.t
val make_array_readwrite : list_storage:Message.rw ListStorage.t -> init:(int -> Message.rw ListStorage.t) -> codecs:'a ListCodecs.t -> (Message.rw, 'a, Message.rw ListStorage.t) Capnp__.InnerArray.t
val string_of_uint8_list : null_terminated:bool -> 'cap ListStorage.t -> string
val struct_of_bytes_slice : 'a Slice.t -> ('a, 'b) StructStorage.t
val struct_of_pointer_slice : 'a Slice.t -> ('a, 'b) StructStorage.t
val make_struct_of_list_index : 'a ListStorage.t -> int -> ('a, 'b) StructStorage.t
val deref_list_pointer : 'cap Slice.t -> 'cap ListStorage.t option
val deref_struct_pointer : 'cap Slice.t -> ('cap, 'a) StructStorage.t option
val deref_opt_struct_pointer : 'a Slice.t option -> ('a, 'b) StructStorage.t option
val void_list_decoders : ('a, unit) ListDecoders.t
val bit_list_decoders : ('a, bool) ListDecoders.t
val int8_list_decoders : ('a, int) ListDecoders.t
val int16_list_decoders : ('a, int) ListDecoders.t
val int32_list_decoders : ('a, Int32.t) ListDecoders.t
val int64_list_decoders : ('a, Int64.t) ListDecoders.t
val uint8_list_decoders : ('a, int) ListDecoders.t
val uint16_list_decoders : ('a, int) ListDecoders.t
val uint32_list_decoders : ('a, Uint32.t) ListDecoders.t
val uint64_list_decoders : ('a, Uint64.t) ListDecoders.t
val float32_list_decoders : ('a, float) ListDecoders.t
val float64_list_decoders : ('a, float) ListDecoders.t
val text_list_decoders : ('a, string) ListDecoders.t
val blob_list_decoders : ('a, string) ListDecoders.t
val struct_list_decoders : ('a, ('a, 'b) StructStorage.t option) ListDecoders.t
val get_root_struct : 'cap Message.t -> ('cap, 'a) StructStorage.t option
val get_bit : default:bool -> ('cap, 'a) StructStorage.t option -> byte_ofs:int -> bit_ofs:int -> bool
val get_int8 : default:int -> ('cap, 'a) StructStorage.t option -> int -> int
val get_int16 : default:int -> ('cap, 'a) StructStorage.t option -> int -> int
val get_int32 : default:int32 -> ('cap, 'a) StructStorage.t option -> int -> int32
val get_int64 : default:int64 -> ('cap, 'a) StructStorage.t option -> int -> int64
val get_uint8 : default:int -> ('cap, 'a) StructStorage.t option -> int -> int
val get_uint16 : default:int -> ('cap, 'a) StructStorage.t option -> int -> int
val get_uint32 : default:Uint32.t -> ('cap, 'a) StructStorage.t option -> int -> Uint32.t
val get_uint64 : default:Uint64.t -> ('cap, 'a) StructStorage.t option -> int -> Uint64.t
val get_float32 : default_bits:int32 -> ('cap, 'a) StructStorage.t option -> int -> float
val get_float64 : default_bits:int64 -> ('cap, 'a) StructStorage.t option -> int -> float
val has_field : ('cap, 'a) StructStorage.t option -> int -> bool
val get_text : default:string -> ('cap, 'a) StructStorage.t option -> int -> string
val get_blob : default:string -> ('cap, 'a) StructStorage.t option -> int -> string
val get_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) ListDecoders.t -> (Message.ro, 'b) StructStorage.t option -> int -> (Message.ro, 'a, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_void_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, unit, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_bit_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, bool, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_int8_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_int16_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_int32_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int32, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_int64_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int64, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_uint8_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_uint16_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, int, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_uint32_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, Uint32.t, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_uint64_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, Uint64.t, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_float32_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, float, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_float64_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, float, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_text_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, string, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_blob_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, string, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_struct_list : ?default:Message.ro ListStorage.t -> (Message.ro, 'a) StructStorage.t option -> int -> (Message.ro, (Message.ro, 'b) StructStorage.t option, Message.ro ListStorage.t) Capnp__.InnerArray.t
val get_struct : ?default:(Message.ro, 'a) StructStorage.t -> (Message.ro, 'b) StructStorage.t option -> int -> (Message.ro, 'a) StructStorage.t option
val get_pointer : ?default:Message.ro Slice.t -> (Message.ro, 'a) StructStorage.t option -> int -> Message.ro Slice.t option
val get_interface : ('cap, 'a) StructStorage.t option -> int -> 'b MessageWrapper.Capability.t option
val pointers_struct : 'a Slice.t -> ('a, 'b) StructStorage.t
val cast_struct : ('a, 'b) StructStorage.t option -> ('a, 'c) StructStorage.t option
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct