nano-client API Reference
Functions
CDR Stream
nano-client API » XCDR Data Format

Functions

NANO_RetCode NANO_CDR_Stream_advance (NANO_CDR_Stream *const self, NANO_usize amount)
 
NANO_u8 * NANO_CDR_Stream_buffer (NANO_CDR_Stream *const self)
 
NANO_usize NANO_CDR_Stream_capacity (const NANO_CDR_Stream *const self)
 
NANO_RetCode NANO_CDR_Stream_deserialize_i16 (NANO_CDR_Stream *const self, NANO_i16 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_i32 (NANO_CDR_Stream *const self, NANO_i32 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_i64 (NANO_CDR_Stream *const self, NANO_i64 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_i8 (NANO_CDR_Stream *const self, NANO_u8 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_octets (NANO_CDR_Stream *const self, NANO_u8 *const val, const NANO_usize val_len)
 
NANO_RetCode NANO_CDR_Stream_deserialize_psequence (NANO_CDR_Stream *const self, NANO_Sequence *const seq, const NANO_usize seq_max)
 
NANO_RetCode NANO_CDR_Stream_deserialize_sequence (NANO_CDR_Stream *const self, NANO_Sequence *const seq, const NANO_usize seq_max, NANO_CDR_Stream_DeserializeCdrFn deserialize_member)
 
NANO_RetCode NANO_CDR_Stream_deserialize_string (NANO_CDR_Stream *const self, char *const *const str, const NANO_usize str_max, NANO_usize *const str_len)
 
NANO_RetCode NANO_CDR_Stream_deserialize_u16 (NANO_CDR_Stream *const self, NANO_u16 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_u32 (NANO_CDR_Stream *const self, NANO_u32 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_u64 (NANO_CDR_Stream *const self, NANO_u64 *const val)
 
NANO_RetCode NANO_CDR_Stream_deserialize_u8 (NANO_CDR_Stream *const self, NANO_u8 *const val)
 
NANO_CDR_Endianness NANO_CDR_Stream_endianness (const NANO_CDR_Stream *const self)
 
NANO_u8 * NANO_CDR_Stream_head (NANO_CDR_Stream *const self)
 
NANO_RetCode NANO_CDR_Stream_initialize (NANO_CDR_Stream *const self, NANO_u8 *const buffer, const NANO_usize buffer_len, const NANO_CDR_Endianness endianness, const NANO_bool owned)
 TODO. More...
 
NANO_usize NANO_CDR_Stream_offset (const NANO_CDR_Stream *const self)
 
void NANO_CDR_Stream_reset (NANO_CDR_Stream *const self)
 
NANO_RetCode NANO_CDR_Stream_rewind (NANO_CDR_Stream *const self, NANO_usize amount)
 TODO. More...
 
NANO_RetCode NANO_CDR_Stream_serialize_i16 (NANO_CDR_Stream *const self, const NANO_i16 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_i32 (NANO_CDR_Stream *const self, const NANO_i32 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_i64 (NANO_CDR_Stream *const self, const NANO_i64 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_i8 (NANO_CDR_Stream *const self, NANO_u8 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_octets (NANO_CDR_Stream *const self, const NANO_u8 *const val, const NANO_usize val_len)
 
NANO_RetCode NANO_CDR_Stream_serialize_psequence (NANO_CDR_Stream *const self, const NANO_Sequence *const seq, const NANO_usize seq_max)
 
NANO_RetCode NANO_CDR_Stream_serialize_sequence (NANO_CDR_Stream *const self, const NANO_Sequence *const seq, const NANO_usize seq_max, NANO_CDR_Stream_SerializeCdrFn serialize_member)
 
NANO_RetCode NANO_CDR_Stream_serialize_string (NANO_CDR_Stream *const self, const char *const *const str, const NANO_usize str_max)
 
NANO_RetCode NANO_CDR_Stream_serialize_u16 (NANO_CDR_Stream *const self, const NANO_u16 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_u32 (NANO_CDR_Stream *const self, const NANO_u32 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_u64 (NANO_CDR_Stream *const self, const NANO_u64 *const val)
 
NANO_RetCode NANO_CDR_Stream_serialize_u8 (NANO_CDR_Stream *const self, const NANO_u8 *const val)
 

Detailed Description

Function Documentation

◆ NANO_CDR_Stream_advance()

NANO_RetCode NANO_CDR_Stream_advance ( NANO_CDR_Stream *const  self,
NANO_usize  amount 
)
Parameters
self
amount
Returns
NANO_RetCode

◆ NANO_CDR_Stream_buffer()

NANO_u8* NANO_CDR_Stream_buffer ( NANO_CDR_Stream *const  self)
Parameters
self
Returns
NANO_u8*

◆ NANO_CDR_Stream_capacity()

NANO_usize NANO_CDR_Stream_capacity ( const NANO_CDR_Stream *const  self)
Parameters
self
Returns
NANO_usize

◆ NANO_CDR_Stream_deserialize_i16()

NANO_RetCode NANO_CDR_Stream_deserialize_i16 ( NANO_CDR_Stream *const  self,
NANO_i16 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_i32()

NANO_RetCode NANO_CDR_Stream_deserialize_i32 ( NANO_CDR_Stream *const  self,
NANO_i32 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_i64()

NANO_RetCode NANO_CDR_Stream_deserialize_i64 ( NANO_CDR_Stream *const  self,
NANO_i64 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_i8()

NANO_RetCode NANO_CDR_Stream_deserialize_i8 ( NANO_CDR_Stream *const  self,
NANO_u8 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_octets()

NANO_RetCode NANO_CDR_Stream_deserialize_octets ( NANO_CDR_Stream *const  self,
NANO_u8 *const  val,
const NANO_usize  val_len 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_psequence()

NANO_RetCode NANO_CDR_Stream_deserialize_psequence ( NANO_CDR_Stream *const  self,
NANO_Sequence *const  seq,
const NANO_usize  seq_max 
)
Parameters
self
seq
seq_max
Returns

◆ NANO_CDR_Stream_deserialize_sequence()

NANO_RetCode NANO_CDR_Stream_deserialize_sequence ( NANO_CDR_Stream *const  self,
NANO_Sequence *const  seq,
const NANO_usize  seq_max,
NANO_CDR_Stream_DeserializeCdrFn  deserialize_member 
)
Parameters
self
seq
seq_max
deserialize_member
Returns

◆ NANO_CDR_Stream_deserialize_string()

NANO_RetCode NANO_CDR_Stream_deserialize_string ( NANO_CDR_Stream *const  self,
char *const *const  str,
const NANO_usize  str_max,
NANO_usize *const  str_len 
)
Parameters
self
str
str_max
str_len
Returns
NANODllExport

◆ NANO_CDR_Stream_deserialize_u16()

NANO_RetCode NANO_CDR_Stream_deserialize_u16 ( NANO_CDR_Stream *const  self,
NANO_u16 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_u32()

NANO_RetCode NANO_CDR_Stream_deserialize_u32 ( NANO_CDR_Stream *const  self,
NANO_u32 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_u64()

NANO_RetCode NANO_CDR_Stream_deserialize_u64 ( NANO_CDR_Stream *const  self,
NANO_u64 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_deserialize_u8()

NANO_RetCode NANO_CDR_Stream_deserialize_u8 ( NANO_CDR_Stream *const  self,
NANO_u8 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_endianness()

NANO_CDR_Endianness NANO_CDR_Stream_endianness ( const NANO_CDR_Stream *const  self)
Parameters
self
Returns
NANO_CDR_Endianness

◆ NANO_CDR_Stream_head()

NANO_u8* NANO_CDR_Stream_head ( NANO_CDR_Stream *const  self)
Parameters
self
Returns
NANO_u8*

◆ NANO_CDR_Stream_initialize()

NANO_RetCode NANO_CDR_Stream_initialize ( NANO_CDR_Stream *const  self,
NANO_u8 *const  buffer,
const NANO_usize  buffer_len,
const NANO_CDR_Endianness  endianness,
const NANO_bool  owned 
)

TODO.

Parameters
self
buffer
buffer_len
endianness
owned
Returns
NANO_RetCode

◆ NANO_CDR_Stream_offset()

NANO_usize NANO_CDR_Stream_offset ( const NANO_CDR_Stream *const  self)
Parameters
self
Returns
NANO_usize

◆ NANO_CDR_Stream_reset()

void NANO_CDR_Stream_reset ( NANO_CDR_Stream *const  self)
Parameters
self

◆ NANO_CDR_Stream_rewind()

NANO_RetCode NANO_CDR_Stream_rewind ( NANO_CDR_Stream *const  self,
NANO_usize  amount 
)

TODO.

Parameters
self
amount
Returns
NANO_RetCode

◆ NANO_CDR_Stream_serialize_i16()

NANO_RetCode NANO_CDR_Stream_serialize_i16 ( NANO_CDR_Stream *const  self,
const NANO_i16 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_i32()

NANO_RetCode NANO_CDR_Stream_serialize_i32 ( NANO_CDR_Stream *const  self,
const NANO_i32 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_i64()

NANO_RetCode NANO_CDR_Stream_serialize_i64 ( NANO_CDR_Stream *const  self,
const NANO_i64 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_i8()

NANO_RetCode NANO_CDR_Stream_serialize_i8 ( NANO_CDR_Stream *const  self,
NANO_u8 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_octets()

NANO_RetCode NANO_CDR_Stream_serialize_octets ( NANO_CDR_Stream *const  self,
const NANO_u8 *const  val,
const NANO_usize  val_len 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_psequence()

NANO_RetCode NANO_CDR_Stream_serialize_psequence ( NANO_CDR_Stream *const  self,
const NANO_Sequence *const  seq,
const NANO_usize  seq_max 
)
Parameters
self
seq
seq_max
Returns

◆ NANO_CDR_Stream_serialize_sequence()

NANO_RetCode NANO_CDR_Stream_serialize_sequence ( NANO_CDR_Stream *const  self,
const NANO_Sequence *const  seq,
const NANO_usize  seq_max,
NANO_CDR_Stream_SerializeCdrFn  serialize_member 
)
Parameters
self
seq
seq_max
serialize_member
Returns

◆ NANO_CDR_Stream_serialize_string()

NANO_RetCode NANO_CDR_Stream_serialize_string ( NANO_CDR_Stream *const  self,
const char *const *const  str,
const NANO_usize  str_max 
)
Parameters
self
str
str_max
Returns

◆ NANO_CDR_Stream_serialize_u16()

NANO_RetCode NANO_CDR_Stream_serialize_u16 ( NANO_CDR_Stream *const  self,
const NANO_u16 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_u32()

NANO_RetCode NANO_CDR_Stream_serialize_u32 ( NANO_CDR_Stream *const  self,
const NANO_u32 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_u64()

NANO_RetCode NANO_CDR_Stream_serialize_u64 ( NANO_CDR_Stream *const  self,
const NANO_u64 *const  val 
)
Parameters
self
val
Returns

◆ NANO_CDR_Stream_serialize_u8()

NANO_RetCode NANO_CDR_Stream_serialize_u8 ( NANO_CDR_Stream *const  self,
const NANO_u8 *const  val 
)
Parameters
self
val
Returns