Union_info — Module representing a C structure
Union_info represents a union type. A union has methods and fields. Unions can optionally have a discriminator, which is a field deciding what type of real union fields is valid for specified instance.
val unioninfo : t Ctypes.structure Ctypes.typval get_n_fields : t Ctypes.structure Ctypes.ptr -> intObtain the number of fields this union has.
val get_size : t Ctypes.structure Ctypes.ptr -> intObtain the total size of the union.
val get_alignment : t Ctypes.structure Ctypes.ptr -> intObtain the required alignment of the union.
val get_n_methods : t Ctypes.structure Ctypes.ptr -> intObtain the number of methods this union has.
val get_field :
t Ctypes.structure Ctypes.ptr ->
int ->
Field_info.t Ctypes.structure Ctypes.ptrObtain the type information for field with specified index.
val get_method :
t Ctypes.structure Ctypes.ptr ->
int ->
Function_info.t Ctypes.structure Ctypes.ptrObtain the type information for method with specified index.
val find_method :
t Ctypes.structure Ctypes.ptr ->
string ->
Function_info.t Ctypes.structure Ctypes.ptr optionObtain the type information for method named name .
val is_discriminated : t Ctypes.structure Ctypes.ptr -> boolReturn true if this union contains discriminator field.
val get_discriminator_offset : t Ctypes.structure Ctypes.ptr -> intReturns offset of the discriminator field in the structure.
val get_discriminator_type :
t Ctypes.structure Ctypes.ptr ->
Type_info.t Ctypes.structure Ctypes.ptrObtain the type information of the union discriminator.
val get_discriminator :
t Ctypes.structure Ctypes.ptr ->
int ->
Constant_info.t Ctypes.structure Ctypes.ptrObtain discriminator value assigned for n-th union field, i.e. n-th union field is the active one if discriminator contains this constant.
val cast_from_baseinfo :
Base_info.t Ctypes.structure Ctypes.ptr ->
t Ctypes.structure Ctypes.ptrJust cast OCaml Ctypes base info to union info.
val cast_to_baseinfo :
t Ctypes.structure Ctypes.ptr ->
Base_info.t Ctypes.structure Ctypes.ptrJust cast OCaml Ctypes union info to base info
val from_baseinfo :
Base_info.t Ctypes.structure Ctypes.ptr ->
t Ctypes.structure Ctypes.ptrReturn a Union_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo :
t Ctypes.structure Ctypes.ptr ->
Base_info.t Ctypes.structure Ctypes.ptrReturn a Base_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo :
Registered_type_info.t Ctypes.structure Ctypes.ptr ->
t Ctypes.structure Ctypes.ptrJust cast OCaml Ctypes registeredtype info to union info.
val cast_to_registeredtypeinfo :
t Ctypes.structure Ctypes.ptr ->
Registered_type_info.t Ctypes.structure Ctypes.ptrJust cast OCaml Ctypes union info to registeredtype info
val from_registeredtypeinfo :
Registered_type_info.t Ctypes.structure Ctypes.ptr ->
t Ctypes.structure Ctypes.ptrReturn a Union_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo :
t Ctypes.structure Ctypes.ptr ->
Registered_type_info.t Ctypes.structure Ctypes.ptrReturn a Registered_type_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.