# Module cloudi_response_info

- Description
- Data Types
- Function Index
- Function Details

### CloudI ResponseInfo Creation and Parsing

The ResponseInfo format is consistent with the RequestInfo format, defined in the cloudi_request_info module.

Copyright © 2014-2020 Michael Truog

Version: 2.0.1 Dec 3 2021 17:15:35 ------------------------------------------------------------------------

Authors: Michael Truog (`mjtruog at protonmail dot com`).

## Description

### CloudI ResponseInfo Creation and Parsing

The ResponseInfo format is consistent with the RequestInfo format, defined in the cloudi_request_info module.

## Data Types

### format()

`format() = cloudi_request_info:format()`

## Function Index

key_value_new/1 | #### New ResponseInfo key/value data. ResponseInfo is meant to contain key/value pairs that is response meta-data.
key_value_new/2 | #### New ResponseInfo key/value data. ResponseInfo is meant to contain key/value pairs that is response meta-data.
key_value_parse/1 | #### Parse ResponseInfo key/value data. ResponseInfo is meant to contain key/value pairs that is response meta-data.
key_value_parse/2 | #### Parse ResponseInfo key/value data to the return type specified. ResponseInfo is meant to contain key/value pairs that is response meta-data.
lookup_content_type/0 | #### Provide a lookup with common content types. .
lookup_content_type/1 | #### Provide a lookup with common content types while setting string type of the content type value. .
lookup_content_type/2 | #### Perform a lookup on a file extension with temporary data to minimize memory consumption. .

## Function Details

### key_value_new/1

`key_value_new(ResponseInfo::cloudi_key_value:key_values()) -> Result::binary()`

#### New ResponseInfo key/value data.

ResponseInfo is meant to contain key/value pairs that is response meta-data. Create the binary ResponseInfo data with any supported data structure.

### key_value_new/2

`key_value_new(ResponseInfo::cloudi_key_value:key_values(), Format::format()) -> Result::binary()`

#### New ResponseInfo key/value data.

ResponseInfo is meant to contain key/value pairs that is response meta-data. Create the binary ResponseInfo data with any supported data structure.

### key_value_parse/1

`key_value_parse(ResponseInfo::binary() | cloudi_key_value:key_values()) -> Result::#{cloudi_key_value:key() := cloudi_key_value:value()}`

#### Parse ResponseInfo key/value data.

ResponseInfo is meant to contain key/value pairs that is response meta-data.

### key_value_parse/2

`key_value_parse(ResponseInfo::binary() | cloudi_key_value:key_values(), ResultType::map | list) -> Result::#{cloudi_key_value:key() := cloudi_key_value:value()} | [{cloudi_key_value:key(), cloudi_key_value:value()}]`

#### Parse ResponseInfo key/value data to the return type specified.

ResponseInfo is meant to contain key/value pairs that is response meta-data.

### lookup_content_type/0

`lookup_content_type() -> trie:trie()`

#### Provide a lookup with common content types.

### lookup_content_type/1

`lookup_content_type(X1::binary | list) -> trie:trie()`

#### Provide a lookup with common content types while setting string type of the content type value.

### lookup_content_type/2

`lookup_content_type(Format::binary | list, FileExtension::string()) -> {ok, {request | attachment, binary() | string()}} | error`

#### Perform a lookup on a file extension with temporary data to minimize memory consumption.

Generated by EDoc