From ed97251cc05b9759b1cd17c45e6d277d9172cdf3 Mon Sep 17 00:00:00 2001 From: Acuadros95 Date: Tue, 17 May 2022 07:42:43 +0000 Subject: [PATCH 1/3] micro-ROS Utils API reference auto-update 17-05-2022 07:42 --- .../utils_doc/Modules/group__typeutils.md | 62 ++++++++++++++++--- 1 file changed, 55 insertions(+), 7 deletions(-) diff --git a/_includes/utils_doc/Modules/group__typeutils.md b/_includes/utils_doc/Modules/group__typeutils.md index 0c2b87e2..349c125d 100644 --- a/_includes/utils_doc/Modules/group__typeutils.md +++ b/_includes/utils_doc/Modules/group__typeutils.md @@ -1,15 +1,53 @@ # micro-ROS Types Utilities +## Classes + +| | Name | +| -------------- | -------------- | +| struct | **[micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md)**
Memory rule. | +| struct | **[micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md)**
Memory configuration string. | + +## Types + +| | Name | +| -------------- | -------------- | +| typedef struct [micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md) | **[micro_ros_utilities_memory_rule_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_rule_t)**
Memory rule. | +| typedef struct [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_conf_t)**
Memory configuration string. | + ## Functions | | Name | | -------------- | -------------- | -| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)
Returns a string with the type instronspection data. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the dynamic memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the static memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Allocates the dynamic memory required for a message. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Deallocates the dynamic memory of a message. | +| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)
Returns a string with the type introspection data. | +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the dynamic memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the static memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Allocates the dynamic memory required for a message. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Deallocates the dynamic memory of a message. | + +## Attributes + +| | Name | +| -------------- | -------------- | +| const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_default](Modules/group__typeutils.md#variable-micro_ros_utilities_memory_conf_default)** | + +## Types Documentation + +### typedef micro_ros_utilities_memory_rule_t + +```cpp +typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t; +``` + +Memory rule. + +### typedef micro_ros_utilities_memory_conf_t + +```cpp +typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t; +``` + +Memory configuration string. ## Functions Documentation @@ -22,7 +60,7 @@ MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_utilities_type_inf ) ``` -Returns a string with the type instronspection data. +Returns a string with the type introspection data. **Parameters**: @@ -215,6 +253,16 @@ Deallocates the dynamic memory of a message. +## Attributes Documentation + +### variable micro_ros_utilities_memory_conf_default + +```cpp +static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_default = +{20, 5, 5, NULL, 0, NULL}; +``` + + From f2622c3961c78657848568770f6423953fbe639b Mon Sep 17 00:00:00 2001 From: pablogs9 Date: Thu, 19 May 2022 06:12:06 +0000 Subject: [PATCH 2/3] micro-ROS Utils API reference auto-update 19-05-2022 06:11 --- .../utils_doc/Modules/group__typeutils.md | 62 ++++++++++++++++--- 1 file changed, 55 insertions(+), 7 deletions(-) diff --git a/_includes/utils_doc/Modules/group__typeutils.md b/_includes/utils_doc/Modules/group__typeutils.md index 0c2b87e2..349c125d 100644 --- a/_includes/utils_doc/Modules/group__typeutils.md +++ b/_includes/utils_doc/Modules/group__typeutils.md @@ -1,15 +1,53 @@ # micro-ROS Types Utilities +## Classes + +| | Name | +| -------------- | -------------- | +| struct | **[micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md)**
Memory rule. | +| struct | **[micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md)**
Memory configuration string. | + +## Types + +| | Name | +| -------------- | -------------- | +| typedef struct [micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md) | **[micro_ros_utilities_memory_rule_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_rule_t)**
Memory rule. | +| typedef struct [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_conf_t)**
Memory configuration string. | + ## Functions | | Name | | -------------- | -------------- | -| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)
Returns a string with the type instronspection data. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the dynamic memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the static memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Allocates the dynamic memory required for a message. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Deallocates the dynamic memory of a message. | +| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)
Returns a string with the type introspection data. | +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the dynamic memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the static memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Allocates the dynamic memory required for a message. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Deallocates the dynamic memory of a message. | + +## Attributes + +| | Name | +| -------------- | -------------- | +| const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_default](Modules/group__typeutils.md#variable-micro_ros_utilities_memory_conf_default)** | + +## Types Documentation + +### typedef micro_ros_utilities_memory_rule_t + +```cpp +typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t; +``` + +Memory rule. + +### typedef micro_ros_utilities_memory_conf_t + +```cpp +typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t; +``` + +Memory configuration string. ## Functions Documentation @@ -22,7 +60,7 @@ MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_utilities_type_inf ) ``` -Returns a string with the type instronspection data. +Returns a string with the type introspection data. **Parameters**: @@ -215,6 +253,16 @@ Deallocates the dynamic memory of a message. +## Attributes Documentation + +### variable micro_ros_utilities_memory_conf_default + +```cpp +static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_default = +{20, 5, 5, NULL, 0, NULL}; +``` + + From 499159bd40db7dafc69867ddeb05c88710fd9f23 Mon Sep 17 00:00:00 2001 From: acuadros95 Date: Thu, 19 May 2022 11:14:49 +0200 Subject: [PATCH 3/3] Test CI --- _docs/api/utils/index.md | 2 + ...tmicro__ros__utilities__memory__conf__t.md | 69 +++++++++++++++++++ ...tmicro__ros__utilities__memory__rule__t.md | 37 ++++++++++ .../utils_doc/Modules/group__stringutils.md | 1 - .../utils_doc/Modules/group__typeutils.md | 46 ++----------- 5 files changed, 115 insertions(+), 40 deletions(-) create mode 100644 _includes/utils_doc/Classes/structmicro__ros__utilities__memory__conf__t.md create mode 100644 _includes/utils_doc/Classes/structmicro__ros__utilities__memory__rule__t.md diff --git a/_docs/api/utils/index.md b/_docs/api/utils/index.md index d80938dd..1cb4a3fb 100644 --- a/_docs/api/utils/index.md +++ b/_docs/api/utils/index.md @@ -5,3 +5,5 @@ permalink: /docs/api/utils/ {% include utils_doc/Modules/group__typeutils.md %} {% include utils_doc/Modules/group__stringutils.md %} +{% include utils_doc/Classes/structmicro__ros__utilities__memory__rule__t.md %} +{% include utils_doc/Classes/structmicro__ros__utilities__memory__conf__t.md %} \ No newline at end of file diff --git a/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__conf__t.md b/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__conf__t.md new file mode 100644 index 00000000..0992c823 --- /dev/null +++ b/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__conf__t.md @@ -0,0 +1,69 @@ +# micro_ros_utilities_memory_conf_t + +Memory configuration string. + + +`#include ` + +## Public Attributes + +| | Name | +| -------------- | -------------- | +| size_t | **[max_string_capacity](#variable-max_string_capacity)**
Maximum string capacity to use for msg fields in case they don't have a custom rule assigned to them. | +| size_t | **[max_ros2_type_sequence_capacity](#variable-max_ros2_type_sequence_capacity)**
Maximum capacity to use for sequence type msg fields (ie: unbounded arrays and lists) which contain ROS 2 msg types, in case they don't have a custom rule assigned to them. | +| size_t | **[max_basic_type_sequence_capacity](#variable-max_basic_type_sequence_capacity)**
Maximum capacity to use for sequence type msg fields (ie: unbounded arrays and lists) which contain basic types (ie: primitive field types), in case they don't have a custom rule assigned to them. | +| const [micro_ros_utilities_memory_rule_t](#micro_ros_utilities_memory_rule_t) * | **[rules](#variable-rules)**
All rules defined in this configuration. | +| size_t | **[n_rules](#variable-n_rules)**
Total number of rules defined in this configuration. | +| const rcutils_allocator_t * | **[allocator](#variable-allocator)**
The allocator to use when applying this configuration. | + +## Public Attributes Documentation + +### variable max_string_capacity + +```cpp +size_t max_string_capacity; +``` + +Maximum string capacity to use for msg fields in case they don't have a custom rule assigned to them. + +### variable max_ros2_type_sequence_capacity + +```cpp +size_t max_ros2_type_sequence_capacity; +``` + +Maximum capacity to use for sequence type msg fields (ie: unbounded arrays and lists) which contain ROS 2 msg types, in case they don't have a custom rule assigned to them. + +### variable max_basic_type_sequence_capacity + +```cpp +size_t max_basic_type_sequence_capacity; +``` + +Maximum capacity to use for sequence type msg fields (ie: unbounded arrays and lists) which contain basic types (ie: primitive field types), in case they don't have a custom rule assigned to them. + +### variable rules + +```cpp +const micro_ros_utilities_memory_rule_t * rules; +``` + +All rules defined in this configuration. + +### variable n_rules + +```cpp +size_t n_rules; +``` + +Total number of rules defined in this configuration. + +### variable allocator + +```cpp +const rcutils_allocator_t * allocator; +``` + +The allocator to use when applying this configuration. + +------------------------------- \ No newline at end of file diff --git a/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__rule__t.md b/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__rule__t.md new file mode 100644 index 00000000..99dd7cae --- /dev/null +++ b/_includes/utils_doc/Classes/structmicro__ros__utilities__memory__rule__t.md @@ -0,0 +1,37 @@ +# micro_ros_utilities_memory_rule_t + +Memory rule. + + +`#include ` + +## Public Attributes + +| | Name | +| -------------- | -------------- | +| const char * | **[rule](#variable-rule)** | +| size_t | **[size](#variable-size)** | + +## Public Attributes Documentation + +### variable rule + +```cpp +const char * rule; +``` + + +Pattern matching the fully qualified name of a msg field. + + +### variable size + +```cpp +size_t size; +``` + + +Maximum string or sequence capacity for fields matching [rule](#variable-rule). + + +------------------------------- \ No newline at end of file diff --git a/_includes/utils_doc/Modules/group__stringutils.md b/_includes/utils_doc/Modules/group__stringutils.md index 9ce78792..efba4115 100644 --- a/_includes/utils_doc/Modules/group__stringutils.md +++ b/_includes/utils_doc/Modules/group__stringutils.md @@ -12,7 +12,6 @@ | MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_remove_tail_chars](#function-micro_ros_string_utilities_remove_tail_chars)**(const rosidl_runtime_c__String str, const size_t n)
Removes characters from the end of a string. | | MICRO_ROS_UTILITIES_PUBLIC void | **[micro_ros_string_utilities_destroy](#function-micro_ros_string_utilities_destroy)**(rosidl_runtime_c__String *const str)
Destroys a rosidl_runtime_c__String. | - ## Functions Documentation ### function micro_ros_string_utilities_init diff --git a/_includes/utils_doc/Modules/group__typeutils.md b/_includes/utils_doc/Modules/group__typeutils.md index 349c125d..a422a81e 100644 --- a/_includes/utils_doc/Modules/group__typeutils.md +++ b/_includes/utils_doc/Modules/group__typeutils.md @@ -4,51 +4,19 @@ | | Name | | -------------- | -------------- | -| struct | **[micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md)**
Memory rule. | -| struct | **[micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md)**
Memory configuration string. | - -## Types - -| | Name | -| -------------- | -------------- | -| typedef struct [micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md) | **[micro_ros_utilities_memory_rule_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_rule_t)**
Memory rule. | -| typedef struct [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_conf_t)**
Memory configuration string. | +| struct | **[micro_ros_utilities_memory_rule_t](#micro_ros_utilities_memory_rule_t)**
Memory rule. | +| struct | **[micro_ros_utilities_memory_conf_t](#micro_ros_utilities_memory_conf_t)**
Memory configuration string. | ## Functions | | Name | | -------------- | -------------- | | MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)
Returns a string with the type introspection data. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the dynamic memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Returns the static memory size that will be used for a type. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Allocates the dynamic memory required for a message. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | -| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)
Deallocates the dynamic memory of a message. | - -## Attributes - -| | Name | -| -------------- | -------------- | -| const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_default](Modules/group__typeutils.md#variable-micro_ros_utilities_memory_conf_default)** | - -## Types Documentation - -### typedef micro_ros_utilities_memory_rule_t - -```cpp -typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t; -``` - -Memory rule. - -### typedef micro_ros_utilities_memory_conf_t - -```cpp -typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t; -``` - -Memory configuration string. - +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the dynamic memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)
Returns the static memory size that will be used for a type. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Allocates the dynamic memory required for a message. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | +| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Deallocates the dynamic memory of a message. | ## Functions Documentation