MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS … More...
MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS …
Read is done at the position of MkBufferStreamS::storage->cur. After read the cur is incemented with read-sizeof characters.
#define MkBufferStreamReadALL | ( | ... | ) |
Definition at line 722 of file kernel_overload_mk.h.
#define MkBufferStreamReadALL_C | ( | ... | ) |
Definition at line 724 of file kernel_overload_mk.h.
#define MkBufferStreamReadALL_E | ( | ... | ) |
Definition at line 723 of file kernel_overload_mk.h.
#define MkBufferStreamReadALL_e | ( | ... | ) |
Definition at line 725 of file kernel_overload_mk.h.
#define MkBufferStreamReadALL_NULL | ( | ... | ) |
Definition at line 721 of file kernel_overload_mk.h.
#define MkBufferStreamReadBFL | ( | ... | ) |
Definition at line 729 of file kernel_overload_mk.h.
#define MkBufferStreamReadBFL_C | ( | ... | ) |
Definition at line 731 of file kernel_overload_mk.h.
#define MkBufferStreamReadBFL_E | ( | ... | ) |
Definition at line 730 of file kernel_overload_mk.h.
#define MkBufferStreamReadBFL_e | ( | ... | ) |
Definition at line 732 of file kernel_overload_mk.h.
#define MkBufferStreamReadBFL_NULL | ( | ... | ) |
Definition at line 728 of file kernel_overload_mk.h.
#define MkBufferStreamReadBIN | ( | ... | ) |
Definition at line 762 of file kernel_overload_mk.h.
#define MkBufferStreamReadBIN_C | ( | ... | ) |
Definition at line 764 of file kernel_overload_mk.h.
#define MkBufferStreamReadBIN_E | ( | ... | ) |
Definition at line 763 of file kernel_overload_mk.h.
#define MkBufferStreamReadBIN_e | ( | ... | ) |
Definition at line 765 of file kernel_overload_mk.h.
#define MkBufferStreamReadBIN_NULL | ( | ... | ) |
Definition at line 761 of file kernel_overload_mk.h.
#define MkBufferStreamReadBOL | ( | ... | ) |
Definition at line 767 of file kernel_overload_mk.h.
#define MkBufferStreamReadBOL_C | ( | ... | ) |
Definition at line 769 of file kernel_overload_mk.h.
#define MkBufferStreamReadBOL_E | ( | ... | ) |
Definition at line 768 of file kernel_overload_mk.h.
#define MkBufferStreamReadBOL_e | ( | ... | ) |
Definition at line 770 of file kernel_overload_mk.h.
#define MkBufferStreamReadBOL_NULL | ( | ... | ) |
Definition at line 766 of file kernel_overload_mk.h.
#define MkBufferStreamReadBUF | ( | ... | ) |
Definition at line 734 of file kernel_overload_mk.h.
#define MkBufferStreamReadBUF_C | ( | ... | ) |
Definition at line 736 of file kernel_overload_mk.h.
#define MkBufferStreamReadBUF_E | ( | ... | ) |
Definition at line 735 of file kernel_overload_mk.h.
#define MkBufferStreamReadBUF_e | ( | ... | ) |
Definition at line 737 of file kernel_overload_mk.h.
#define MkBufferStreamReadBUF_NULL | ( | ... | ) |
Definition at line 733 of file kernel_overload_mk.h.
#define MkBufferStreamReadDBL | ( | ... | ) |
Definition at line 772 of file kernel_overload_mk.h.
#define MkBufferStreamReadDBL_C | ( | ... | ) |
Definition at line 774 of file kernel_overload_mk.h.
#define MkBufferStreamReadDBL_E | ( | ... | ) |
Definition at line 773 of file kernel_overload_mk.h.
#define MkBufferStreamReadDBL_e | ( | ... | ) |
Definition at line 775 of file kernel_overload_mk.h.
#define MkBufferStreamReadDBL_NULL | ( | ... | ) |
Definition at line 771 of file kernel_overload_mk.h.
#define MkBufferStreamReadFLT | ( | ... | ) |
Definition at line 777 of file kernel_overload_mk.h.
#define MkBufferStreamReadFLT_C | ( | ... | ) |
Definition at line 779 of file kernel_overload_mk.h.
#define MkBufferStreamReadFLT_E | ( | ... | ) |
Definition at line 778 of file kernel_overload_mk.h.
#define MkBufferStreamReadFLT_e | ( | ... | ) |
Definition at line 780 of file kernel_overload_mk.h.
#define MkBufferStreamReadFLT_NULL | ( | ... | ) |
Definition at line 776 of file kernel_overload_mk.h.
#define MkBufferStreamReadGetNextType | ( | ... | ) |
Definition at line 741 of file kernel_overload_mk.h.
#define MkBufferStreamReadGetNextType_NULL | ( | ... | ) |
Definition at line 740 of file kernel_overload_mk.h.
#define MkBufferStreamReadGetNumItems | ( | ... | ) |
Definition at line 743 of file kernel_overload_mk.h.
#define MkBufferStreamReadGetNumItems_NULL | ( | ... | ) |
Definition at line 742 of file kernel_overload_mk.h.
#define MkBufferStreamReadI32 | ( | ... | ) |
Definition at line 782 of file kernel_overload_mk.h.
#define MkBufferStreamReadI32_C | ( | ... | ) |
Definition at line 784 of file kernel_overload_mk.h.
#define MkBufferStreamReadI32_E | ( | ... | ) |
Definition at line 783 of file kernel_overload_mk.h.
#define MkBufferStreamReadI32_e | ( | ... | ) |
Definition at line 785 of file kernel_overload_mk.h.
#define MkBufferStreamReadI32_NULL | ( | ... | ) |
Definition at line 781 of file kernel_overload_mk.h.
#define MkBufferStreamReadI64 | ( | ... | ) |
Definition at line 787 of file kernel_overload_mk.h.
#define MkBufferStreamReadI64_C | ( | ... | ) |
Definition at line 789 of file kernel_overload_mk.h.
#define MkBufferStreamReadI64_E | ( | ... | ) |
Definition at line 788 of file kernel_overload_mk.h.
#define MkBufferStreamReadI64_e | ( | ... | ) |
Definition at line 790 of file kernel_overload_mk.h.
#define MkBufferStreamReadI64_NULL | ( | ... | ) |
Definition at line 786 of file kernel_overload_mk.h.
#define MkBufferStreamReadI8 | ( | ... | ) |
Definition at line 792 of file kernel_overload_mk.h.
#define MkBufferStreamReadI8_C | ( | ... | ) |
Definition at line 794 of file kernel_overload_mk.h.
#define MkBufferStreamReadI8_E | ( | ... | ) |
Definition at line 793 of file kernel_overload_mk.h.
#define MkBufferStreamReadI8_e | ( | ... | ) |
Definition at line 795 of file kernel_overload_mk.h.
#define MkBufferStreamReadI8_NULL | ( | ... | ) |
Definition at line 791 of file kernel_overload_mk.h.
#define MkBufferStreamReadItemExists | ( | ... | ) |
Definition at line 745 of file kernel_overload_mk.h.
#define MkBufferStreamReadItemExists_NULL | ( | ... | ) |
Definition at line 744 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_END | ( | ... | ) |
Definition at line 747 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_END_C | ( | ... | ) |
Definition at line 749 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_END_E | ( | ... | ) |
Definition at line 748 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_END_NULL | ( | ... | ) |
Definition at line 746 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_START | ( | ... | ) |
Definition at line 751 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_START_1 | ( | bus | ) |
Definition at line 752 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_START_C | ( | ... | ) |
Definition at line 754 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_START_E | ( | ... | ) |
Definition at line 753 of file kernel_overload_mk.h.
#define MkBufferStreamReadL_START_NULL | ( | ... | ) |
Definition at line 750 of file kernel_overload_mk.h.
#define MkBufferStreamReadLONG | ( | ... | ) |
Definition at line 797 of file kernel_overload_mk.h.
#define MkBufferStreamReadLONG_C | ( | ... | ) |
Definition at line 799 of file kernel_overload_mk.h.
#define MkBufferStreamReadLONG_E | ( | ... | ) |
Definition at line 798 of file kernel_overload_mk.h.
#define MkBufferStreamReadLONG_e | ( | ... | ) |
Definition at line 800 of file kernel_overload_mk.h.
#define MkBufferStreamReadLONG_NULL | ( | ... | ) |
Definition at line 796 of file kernel_overload_mk.h.
#define MkBufferStreamReadSTR | ( | ... | ) |
Definition at line 802 of file kernel_overload_mk.h.
#define MkBufferStreamReadSTR_C | ( | ... | ) |
Definition at line 804 of file kernel_overload_mk.h.
#define MkBufferStreamReadSTR_E | ( | ... | ) |
Definition at line 803 of file kernel_overload_mk.h.
#define MkBufferStreamReadSTR_e | ( | ... | ) |
Definition at line 805 of file kernel_overload_mk.h.
#define MkBufferStreamReadSTR_NULL | ( | ... | ) |
Definition at line 801 of file kernel_overload_mk.h.
#define MkBufferStreamReadUndo | ( | ... | ) |
Definition at line 756 of file kernel_overload_mk.h.
#define MkBufferStreamReadUndo_C | ( | ... | ) |
Definition at line 758 of file kernel_overload_mk.h.
#define MkBufferStreamReadUndo_E | ( | ... | ) |
Definition at line 757 of file kernel_overload_mk.h.
#define MkBufferStreamReadUndo_NULL | ( | ... | ) |
Definition at line 755 of file kernel_overload_mk.h.
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadALL_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_BFL *const | val_inout ) |
get a temporary MkBufferListC from all data in the MkBufferStreamC …
If the val_inout is NULL than a temporary MkBufferListC is returned. If the val_inout is not NULL than the memory of the val_inout is reused.
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[in,out] | val_inout | the MkBufferListC - the storage of the input is reused |
MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
MK_NULL
for a non-error result.MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBFL_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_BFL *const | val_out ) |
read a MkBufferListC from the MkBufferStreamC …
The MkBufferListC represent a list-item-type (libmkkernel::MK_LSTT from the MkBufferStreamC. A list-item-type is created with bus.WriteL_START()
and bus.WriteL_END()
and collect multiple items into one item, the list-item-type.
A list-item-type can have an other list-item-type as item, this create a tree-like structure of items.
If the next item in the read-data-package is not a list-item-type than an error is raised. To get all data in the read-data-package as one single MkBufferListC use the MqReadALL.
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the MkBufferListC as return-value |
MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
MK_NULL
for a non-error result.MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBIN_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MkBinaryR *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBOL_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_BOL *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBUF_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_BUF *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadDBL_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_DBL *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadFLT_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_FLT *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkTypeE libmkkernel::MkBufferStreamReadGetNextType_RT | ( | MK_RT | mkrt, |
MK_BUSN const | bus ) |
get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
get the number of items left in the MkBufferStreamC …
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI32_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_I32 *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI64_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_I64 *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI8_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_I8 *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
check if an item exists in the read-data-package …
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
true
or false
END read a list-item-type from the MkBufferStreamC …
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadL_START_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_BUF | buf ) |
START read a list-item-type from the MkBufferStreamC …
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[in] | buf | MK_NULL or a MkBufferC with a list-item-type or an error is raised. |
MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLIST_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_NAT_LIST *const | val_out ) |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLONG_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_LONG *const | val_out ) |
read the long native object from the MkBufferStreamC …
on 64bit use a BufferStreamReadI32 and on 32bit use a BufferStreamReadI64
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the native long object to read |
MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
bus.WriteLONG(MK_LONG val)
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadNEXT_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_NAT_OBJECT *const | val_out ) |
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadSTR_RT | ( | MK_RT | mkrt, |
MK_BUS const | bus, | ||
MK_STRN *const | val_out ) |
read a val_out from the MkBufferStreamC …
The MkBufferStreamReadTT
style of functions always return a val_out or a MkErrorC.
bus.PosToStart()
.MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
[out] | val_out | the new value |
undo the last MkBufferStreamC READ function call …
Decrement the current-access-position by one, to the start of the last read body-item. The next read function call will extract the same item again. Only one undo level is supported.
[in] | mkrt | the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only) |
[in] | bus | the MkBufferStreamS instance to work on |
MkExceptionC | → The default-exception from the Programming-Language-Micro-Kernel (PLMK) |