RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-06 02:14:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Document include/str_list.h

Browse Source 
Fixes: #12050.
Signed-off-by: Claire MASSOT <claire.massot93@gmail.com>
Signed-off-by: Jordan DORNE <jordan.dorne@gmail.com>
Signed-off-by: Kévin CARADANT <kevin.caradant@gmail.com>
Signed-off-by: Gabriel SENTUCQ <perso@kazhord.fr>
Signed-off-by: Maxime ROBERT <maxime.robert1992@gmail.com>
This commit is contained in:
Maxime ROBERT 2015-06-18 15:35:34 +02:00
parent 7fbac49eb0
commit b4e83f440d
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
src/include/str_list.h
View File

@ -7,22 +7,77 @@
#include <string>
#include <vector>
/**
* Split **str** into a list of strings, using the ";,= \t" delimiters and output the result in **str_list**.
*
* @param [in] str String to split and save as list
* @param [out] str_list List modified containing str after it has been split
**/
extern void get_str_list(const std::string& str,
std::list<std::string>& str_list);
/**
* Split **str** into a list of strings, using the **delims** delimiters and output the result in **str_list**.
*
* @param [in] str String to split and save as list
* @param [in] delims characters used to split **str**
* @param [out] str_list List modified containing str after it has been split
**/
extern void get_str_list(const std::string& str,
const char *delims,
std::list<std::string>& str_list);
/**
* Split **str** into a list of strings, using the ";,= \t" delimiters and output the result in **str_vec**.
*
* @param [in] str String to split and save as Vector
* @param [out] str_vec Vector modified containing str after it has been split
**/
extern void get_str_vec(const std::string& str,
std::vector<std::string>& str_vec);
/**
* Split **str** into a list of strings, using the **delims** delimiters and output the result in **str_vec**.
*
* @param [in] str String to split and save as Vector
* @param [in] delims characters used to split **str**
* @param [out] str_vec Vector modified containing str after it has been split
**/
extern void get_str_vec(const std::string& str,
const char *delims,
std::vector<std::string>& str_vec);
/**
* Split **str** into a list of strings, using the ";,= \t" delimiters and output the result in **str_list**.
*
* @param [in] str String to split and save as Set
* @param [out] str_list Set modified containing str after it has been split
**/
extern void get_str_set(const std::string& str,
std::set<std::string>& str_list);
/**
* Split **str** into a list of strings, using the **delims** delimiters and output the result in **str_list**.
*
* @param [in] str String to split and save as Set
* @param [in] delims characters used to split **str**
* @param [out] str_list Set modified containing str after it has been split
**/
extern void get_str_set(const std::string& str,
const char *delims,
std::set<std::string>& str_list);
/**
* Return a String containing the vector **v** joined with **sep**
*
* If **v** is empty, the function returns an empty string
* For each element in **v**,
* it will concatenate this element and **sep** with result
*
* @param [in] v Vector to join as a String
* @param [in] sep String used to join each element from **v**
* @return empty string if **v** is empty or concatenated string
**/
inline std::string str_join(const std::vector<std::string>& v, std::string sep)
{
if (v.empty())