Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ros::serialization::Stream Struct Reference

Stream base-class, provides common functionality for IStream and OStream. More...

#include <serialization.h>

Inheritance diagram for ros::serialization::Stream:
Inheritance graph
[legend]

Public Member Functions

ROS_FORCE_INLINE uint8_t * advance (uint32_t len)
 Advances the stream, checking bounds, and returns a pointer to the position before it was advanced. More...
 
uint8_t * getData ()
 
uint32_t getLength ()
 Returns the amount of space left in the stream. More...
 

Protected Member Functions

 Stream (uint8_t *_data, uint32_t _count)
 

Private Attributes

uint8_t * data_
 
uint8_t * end_
 

Detailed Description

Stream base-class, provides common functionality for IStream and OStream.

Definition at line 662 of file serialization.h.

Constructor & Destructor Documentation

◆ Stream()

ros::serialization::Stream::Stream ( uint8_t *  _data,
uint32_t  _count 
)
inlineprotected

Definition at line 692 of file serialization.h.

Member Function Documentation

◆ advance()

ROS_FORCE_INLINE uint8_t* ros::serialization::Stream::advance ( uint32_t  len)
inline

Advances the stream, checking bounds, and returns a pointer to the position before it was advanced.

Exceptions
StreamOverrunExceptionif len would take this stream past the end of its buffer

Definition at line 673 of file serialization.h.

◆ getData()

uint8_t* ros::serialization::Stream::getData ( )
inline

Definition at line 667 of file serialization.h.

◆ getLength()

uint32_t ros::serialization::Stream::getLength ( )
inline

Returns the amount of space left in the stream.

Definition at line 689 of file serialization.h.

Member Data Documentation

◆ data_

uint8_t* ros::serialization::Stream::data_
private

Definition at line 698 of file serialization.h.

◆ end_

uint8_t* ros::serialization::Stream::end_
private

Definition at line 699 of file serialization.h.


The documentation for this struct was generated from the following file:


roscpp_serialization
Author(s): Josh Faust
autogenerated on Mon Jul 27 2020 03:43:48