package piqilib

  1. Overview
  2. Docs
The Piqi library -- runtime support for multi-format Protobuf/JSON/XML/Piq data serialization and conversion

Install 

dune-project
 Dependency

piqi.org Readme Edit opam file Versions (3)

Authors

  1. A
    Anton Lavrik <alavrik@piqi.org>

Maintainers

  1. A
    Anton Lavrik <alavrik@piqi.org>

Sources

v0.6.16.tar.gz
sha256=7490ab16b6f0f2496b58731c49eaa596985cbaff3be1edf3def8d61dae99fa53
md5=33121fae570f0949426bab875c809b78

doc/piqilib/Piqi/index.html

Module PiqiSource

Sourcemodule Idtable = Piqi_db.Idtable
Sourceval is_boot_mode : bool ref
Sourceval piqi_lang_def : C.T.piqtype ref
Sourceval piqi_spec_def : C.T.piqtype ref
Sourceval piq_def : C.T.piqtype ref
Sourceval typedef_def : C.T.piqtype ref
Sourceval field_def : C.T.piqtype ref
Sourceval option_def : C.T.piqtype ref
Sourceval function_def : C.T.piqtype ref
Sourceval import_def : C.T.piqtype ref
Sourceval piqi_spec : C.T.piqi option ref
Sourceval piqi_lang : C.T.piqi option ref
Sourceval piq_spec : C.T.piqi option ref
Sourceval is_boot_piqi : C.T.piqi -> bool
Sourceval processing_hooks : (C.T.typedef Idtable.M.t -> C.T.piqi -> unit) list ref
Sourceval register_processing_hook : (idtable -> C.T.piqi -> unit) -> unit
Sourceval add_imported_typedefs : C.T.typedef Idtable.M.t -> C.T.typedef list -> C.T.typedef Idtable.M.t
Sourceval find_def : 'a Idtable.M.t -> Idtable.M.key -> 'a
Sourceval is_func_param : [< `alias of C.A.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] -> bool
Sourceval set_is_func_param_flag : [< `alias of C.A.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] -> unit
Sourceval resolve_typename : [< C.T.piqtype ] Idtable.M.t -> Idtable.M.key -> C.T.piqtype
Sourceval resolve_field_typename : [< C.T.piqtype ] Idtable.M.t -> C.F.t -> unit
Sourceval resolve_option_typename : [< C.T.piqtype ] Idtable.M.t -> C.O.t -> unit
Sourceval resolve_def_typenames : [< C.T.piqtype ] Idtable.M.t -> [< `alias of C.A.t | `enum of 'a | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] -> unit
Sourceval check_name : string -> unit
Sourceval check_opt_name : string option -> unit
Sourceval check_dup_names : string -> string list -> unit
Sourceval check_field : C.Field.t -> unit
Sourceval check_def_name : 'a -> string option -> unit
Sourceval check_record : C.R.t -> unit
Sourceval check_option : C.Option.t -> unit
Sourceval check_variant : C.V.t -> unit
Sourceval check_enum_option : C.O.t -> unit
Sourceval check_enum : C.E.t -> unit
Sourceval check_alias : C.A.t -> unit
Sourceval check_list : C.L.t -> unit
Sourceval check_def : [< `alias of C.A.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] -> unit
Sourceval check_resolved_alias : C.A.t -> unit
Sourceval check_resolved_def : [> `alias of C.A.t | `enum of C.E.t | `record of C.R.t | `variant of C.V.t ] -> unit
Sourceval check_no_infinite_types : parent:C.T.namespace -> [< C.T.piqtype variant ] list -> unit
Sourceval is_valid_scoped_extension_name : string -> bool
Sourceval check_extension_name : [< `field of string | `func of string | `import of string | `name of string | `option of string | `typedef of string ] -> unit
Sourceval check_extension_spec : [< `field of string | `func of string | `import of string | `name of string | `option of string | `typedef of string name ] -> unit
Sourceval check_extension : C.Extend.t -> unit
Sourceval debug_loc : string -> unit
Sourceval assert_loc : unit -> unit
Sourceval add_fake_loc : Piqobj.obj -> unit
Sourceval resolve_default_value : Piqi_impl_piqi.any -> Piqi_impl_piqi.piqtype -> unit
Sourceval resolve_field_default : C.F.t -> unit
Sourceval resolve_field_piq_flag_default : C.F.t -> unit
Sourceval resolve_defaults : [> `record of C.R.t ] -> unit
Sourceval copy_obj : 'a -> 'a
Sourceval copy_obj_list : 'a list -> 'a list
Sourceval copy_variant : ?copy_parts:bool -> C.V.t -> C.V.t
Sourceval copy_enum : ?copy_parts:bool -> C.E.t -> C.E.t
Sourceval copy_record : ?copy_parts:bool -> C.R.t -> C.R.t
Sourceval copy_def : copy_parts:bool -> C.T.typedef -> [> `alias of C.T.Piqi_impl_piqi.alias | `enum of C.E.t | `list of C.T.Piqi_impl_piqi.piqi_list | `record of C.R.t | `variant of C.V.t ]
Sourceval copy_defs : ?copy_parts:bool -> C.T.typedef list -> [> `alias of C.T.Piqi_impl_piqi.alias | `enum of C.E.t | `list of C.T.Piqi_impl_piqi.piqi_list | `record of C.R.t | `variant of C.V.t ] list
Sourceval copy_imports : 'a list -> 'a list
Sourceval transform_flag : C.F.t -> unit
Sourceval transform_flags : [> `record of C.R.t ] -> unit
Sourceval check_defs : piqi:C.T.Piqi_impl_piqi.piqi -> C.T.typedef Idtable.M.t -> C.T.typedef list -> unit
Sourceval read_piqi_common : string -> (string * (Piq_parser.L.token * (int * int)) Stream.t) -> C.piq_ast
Sourceval read_piqi_channel : string -> in_channel -> C.piq_ast
Sourceval read_piqi_string : string -> string -> C.piq_ast
Sourceval open_piqi : string -> in_channel
Sourceval read_piqi_file : string -> C.piq_ast
Sourceval check_modname : string -> unit
Sourceval check_assign_module_name : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> string -> C.T.piqi -> unit
Sourceval assign_import_name : C.Import.t -> unit
Sourceval mlobj_to_piqobj : Piqobj_of_protobuf.C.T.piqtype -> (int -> 'a -> C.Piqirun.OBuf.t) -> 'a -> Piqobj.obj
Sourceval mlobj_of_piqobj : (C.Piqirun.t -> 'a) -> Piqobj.obj -> 'a
Sourceval is_unknown_field : string list -> [> `name of string | `named of Piq_ast.Named.t ] -> bool
Sourceval check_unknown_fields : ?prepend:(unit -> unit) -> Piq_gen.C.piq_ast list -> string list -> unit
Sourceval parse_scoped_name : string -> string * string
Sourceval list_replace : 'a list -> ('a -> bool) -> 'a -> 'a list
Sourceval idtable_of_defs : C.T.typedef list -> C.T.typedef Idtable.M.t
Sourceval idtable_of_imports : C.Import.t list -> C.Import.t Idtable.M.t
Sourceval idtable_of_functions : C.T.Func.t list -> C.T.Func.t Idtable.M.t
Sourceval list_of_idtable : 'a Idtable.M.t -> 'b list -> ('b -> Idtable.M.key) -> 'a list
Sourceval apply_extensions : 'a -> Piqobj_of_protobuf.C.T.piqtype -> (C.Piqirun.t -> 'b) -> (int -> 'a -> C.Piqirun.OBuf.t) -> Piqi_impl_piqi.any list -> string list -> override:bool -> 'b
Sourceval apply_option_extensions : ([> `variant of C.V.t ] as 'a) Idtable.M.t -> string -> Piqi_impl_piqi.any list -> string list -> override:bool -> 'a Idtable.M.t
Sourceval apply_field_extensions : ([> `record of C.R.t ] as 'a) Idtable.M.t -> string -> Piqi_impl_piqi.any list -> string list -> override:bool -> 'a Idtable.M.t
Sourceval extend_imports : C.Import.t list -> ([> `import of Idtable.M.key ] * bool * Piqi_impl_piqi.any list) list -> string list -> C.T.Piqi_impl_piqi.import list
Sourceval extend_function : C.T.Piqi_impl_piqi.func Idtable.M.t -> Idtable.M.key -> Piqi_impl_piqi.any list -> string list -> override:bool -> C.T.Piqi_impl_piqi.func Idtable.M.t
Sourceval extend_functions : C.T.Func.t list -> ([> `func of Idtable.M.key ] * bool * Piqi_impl_piqi.any list) list -> string list -> C.T.Piqi_impl_piqi.func list
Sourceval apply_def_extensions : C.T.Piqi_impl_piqi.typedef Idtable.M.t -> [> `field of string | `name of Idtable.M.key | `option of string | `typedef of Idtable.M.key ] -> Piqi_impl_piqi.any list -> string list -> override:bool -> C.T.Piqi_impl_piqi.typedef Idtable.M.t
Sourceval apply_defs_extensions : C.T.typedef list -> ([> `field of string | `name of Idtable.M.key | `option of string | `typedef of Idtable.M.key ] * bool * Piqi_impl_piqi.any list) list -> string list -> C.T.Piqi_impl_piqi.typedef list
Sourceval get_imported_defs : C.Import.t list -> [> `alias of C.T.Piqi_impl_piqi.alias | `enum of C.E.t | `list of C.T.Piqi_impl_piqi.piqi_list | `record of C.R.t | `variant of C.V.t ] list
Sourceval make_param_name : C.T.Func.t -> string -> string
Sourceval resolve_param : C.T.Func.t -> string -> [< `alias of C.A.t | `enum of C.E.t | `list of C.L.t | `name of Piqi_impl_piqi.Piqi_impl_piqi.typename | `record of C.R.t | `variant of C.V.t ] -> [> `alias of C.T.Alias.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ]
Sourceval process_func : C.T.Func.t -> ([> `alias of C.T.Alias.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] * (Piqi_impl_piqi.Piqi_impl_piqi.name * (Piqi_impl_piqi.Piqi_impl_piqi.typedef -> unit))) list
Sourceval get_function_defs : C.T.typedef list -> C.T.Func.t list -> [> `alias of C.A.t | `enum of C.E.t | `list of C.L.t | `record of C.R.t | `variant of C.V.t ] list * (Piqi_impl_piqi.Piqi_impl_piqi.typedef -> unit) Idtable.M.t
Sourceval prepare_included_piqi_ast : [> `list of ([> `named of Piq_ast.Named.t ] as 'a) list ] -> 'a list
Sourceval expand_includes : C.P.t -> C.P.t list -> C.T.Piqi_impl_piqi.piqi
Sourceval is_extension : string -> bool
Sourceval find_piqi_file : C.P.t -> Piqi_db.Piqitable.M.key -> Piqi_db.Piqitable.M.key * string
Sourceval find_extensions : C.P.t -> Piqi_db.Piqitable.M.key list
Sourceval pre_process_piqi : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> fname:string -> ?ast:C.piq_ast -> C.T.piqi -> C.T.piqi
Sourceval is_processed : C.P.t -> bool
Sourceval is_being_processed : C.P.t -> C.P.t list -> bool
Sourceval process_piqi : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> ?include_path:C.P.t list -> ?fname:string -> ?ast:C.piq_ast -> cache:bool -> C.T.piqi -> C.T.piqi
Sourceval load_piqi_file : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> ?include_path:C.P.t list -> string -> C.T.piqi
Sourceval load_piqi_ast : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> ?include_path:C.P.t list -> cache:bool -> string -> C.piq_ast -> C.T.piqi
Sourceval load_piqi_module : ?include_path:C.P.t list -> Piqi_db.Piqitable.M.key -> string -> C.T.piqi
Sourceval load_imports : C.T.piqi -> C.Import.t list -> unit
Sourceval load_includes : include_path:C.P.t list -> C.T.piqi -> C.Includ.t list -> Piqi_impl_piqi.Piqi_impl_piqi.piqi list
Sourceval load_include : include_path:C.P.t list -> C.T.piqi -> C.Includ.t -> C.P.t
Sourceval piqi_loader : ?modname:Piqi_impl_piqi.Piqi_impl_piqi.word -> string -> C.T.piqi
Sourceval embedded_modname : string
Sourceval find_embedded_piqtype : string -> Piqi_db.C.T.piqtype
Sourceval boot : unit -> unit
Sourceval load_piqi : string -> in_channel -> C.T.piqi
Sourceval reconsitute_extended_functions : C.T.Func.t list -> C.T.typedef list -> C.T.Func.t list
Sourceval expand_function : C.T.Func.t -> C.T.Func.t
Sourceval expand_piqi : extensions:bool -> functions:bool -> C.P.t -> C.P.t
Sourceval lang_to_spec : C.P.t -> C.P.t
Sourceval piqi_to_ast : ?is_external_mode:bool -> C.T.Piqi_impl_piqi.piqi -> Piqobj_to_piq.C.piq_ast
Sourceval transform_piqi_ast : C.piq_ast -> Piq_ast.Piq_ast.ast
Sourceval piqi_to_piqobj : ?piqi_piqtype:C.T.piqtype -> ?add_codes:bool -> C.P.t -> Piqobj.obj
Sourceval piqi_of_piqobj : ?process:bool -> Piqobj.obj -> C.T.piqi
Sourceval piqi_to_pb : ?code:int -> C.P.t -> Piqobj_to_protobuf.C.Piqirun.OBuf.t
Sourceval piqi_of_pb : ?process:bool -> Piqobj_of_protobuf.C.Piqirun.t -> C.T.piqi
Sourceval get_piqi_deps : ?only_imports:bool -> C.P.t -> C.P.t list