mirror of
https://github.com/boostorg/convert.git
synced 2026-02-10 23:32:25 +00:00
245 lines
17 KiB
XML
245 lines
17 KiB
XML
<?xml version="1.0" standalone="yes"?>
|
|
<library-reference id="convert_reference"><title>Convert Reference</title><header name="boost/convert.hpp">
|
|
<namespace name="boost">
|
|
<struct name="throw_on_failure_type"><enum name="type"/>
|
|
</struct><namespace name="cnv">
|
|
<struct name="adapter"><template>
|
|
<template-type-parameter name=""/>
|
|
<template-type-parameter name=""/>
|
|
<template-type-parameter name=""/>
|
|
</template><typedef name="this_type"><type><classname>adapter</classname></type></typedef>
|
|
<method-group name="public member functions">
|
|
<method name="value_or"><type><classname>this_type</classname> &</type><parameter name="fallback"><paramtype>TypeOut const &</paramtype></parameter></method>
|
|
<method name="operator()"><type>TypeOut</type><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter></method>
|
|
</method-group>
|
|
<constructor><parameter name="cnv"><paramtype>Converter const &</paramtype></parameter></constructor>
|
|
</struct></namespace>
|
|
<data-member name="throw_on_failure"><type>throw_on_failure_type::type const</type></data-member>
|
|
<function name="convert"><type>boost::enable_if< cnv::is_cnv< Converter, TypeIn, TypeOut >, boost::optional< TypeOut > >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
<template-type-parameter name="Converter"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="converter"><paramtype>Converter const &</paramtype></parameter><purpose>The main Boost.Convert deployment interface. </purpose><description><para>This is the Boost.Convert main interface. For example, <programlisting language="c++"><classname alt="boost::cnv::basic_stringstream">boost::cnv::cstringstream</classname> cnv;
|
|
|
|
int i1 = boost::convert<int>(" 12", cnv(std::skipws)).value();
|
|
int i2 = boost::convert<int>("uhm", cnv).value_or(-1);
|
|
string s1 = boost::convert<string>(123.456, cnv)).value();
|
|
string s2 = boost::convert<string>(123.456, cnv)).value_or("failed");
|
|
</programlisting> </para></description></function>
|
|
<function name="convert"><type>boost::enable_if< cnv::is_cnv< Converter, TypeIn, TypeOut >, TypeOut >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
<template-type-parameter name="Converter"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="converter"><paramtype>Converter const &</paramtype></parameter><parameter name=""><paramtype>throw_on_failure_type::type</paramtype></parameter></function>
|
|
<function name="convert"><type>boost::enable_if_c< cnv::is_cnv< Converter, TypeIn, TypeOut >::value &&boost::is_convertible< FallbackValue, TypeOut >::value, TypeOut >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
<template-type-parameter name="Converter"/>
|
|
<template-type-parameter name="FallbackValue"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="converter"><paramtype>Converter const &</paramtype></parameter><parameter name="fallback"><paramtype>FallbackValue const &</paramtype></parameter></function>
|
|
<function name="convert"><type>boost::enable_if_c< cnv::is_cnv< Converter, TypeIn, TypeOut >::value &&cnv::is_fun< FallbackFunc, TypeOut >::value, TypeOut >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
<template-type-parameter name="Converter"/>
|
|
<template-type-parameter name="FallbackFunc"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="converter"><paramtype>Converter const &</paramtype></parameter><parameter name="fallback"><paramtype>FallbackFunc</paramtype></parameter></function>
|
|
<function name="convert"><type>boost::enable_if< cnv::is_cnv< Converter, TypeIn, TypeOut >, typename <classname>boost::cnv::adapter</classname>< TypeOut, TypeIn, Converter > >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
<template-type-parameter name="Converter"/>
|
|
</template><parameter name="cnv"><paramtype>Converter const &</paramtype></parameter><purpose>The main Boost.Convert deployment interface with algorithms. </purpose><description><para>This the Boost.Convert main deployment interface with algorithms. For example, <programlisting language="c++">boost::array<char const*, 3> strs = {{ " 5", "0XF", "not an int" }};
|
|
std::vector<int> ints;
|
|
<classname alt="boost::cnv::basic_stringstream">boost::cnv::cstringstream</classname> cnv;
|
|
|
|
cnv(std::hex)(std::skipws);
|
|
|
|
std::transform(
|
|
strings.begin(),
|
|
strings.end(),
|
|
std::back_inserter(integers),
|
|
boost::convert<int>(cnv).value_or(INT_MAX));
|
|
</programlisting> </para></description></function>
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/lexical_cast.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="lexical_cast"><method-group name="public member functions">
|
|
<method name="operator()" cv="const"><type>void</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="TypeIn"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< TypeOut > &</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct></namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/parameters.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="base"><enum name="type"><enumvalue name="dec"><default>=10</default></enumvalue><enumvalue name="hex"><default>=16</default></enumvalue><enumvalue name="oct"><default>=8</default></enumvalue></enum>
|
|
</struct><struct name="notation"><enum name="type"><enumvalue name="fixed"/><enumvalue name="scientific"/></enum>
|
|
</struct><namespace name="parameter">
|
|
<function name="BOOST_PARAMETER_KEYWORD"><type/><parameter name=""><paramtype>type</paramtype></parameter><parameter name=""><paramtype><classname>base</classname></paramtype></parameter></function>
|
|
<function name="BOOST_PARAMETER_KEYWORD"><type/><parameter name=""><paramtype>type</paramtype></parameter><parameter name=""><paramtype>locale</paramtype></parameter></function>
|
|
<function name="BOOST_PARAMETER_KEYWORD"><type/><parameter name=""><paramtype>type</paramtype></parameter><parameter name=""><paramtype>precision</paramtype></parameter></function>
|
|
<function name="BOOST_PARAMETER_KEYWORD"><type/><parameter name=""><paramtype>type</paramtype></parameter><parameter name=""><paramtype>uppercase</paramtype></parameter></function>
|
|
<function name="BOOST_PARAMETER_KEYWORD"><type/><parameter name=""><paramtype>type</paramtype></parameter><parameter name=""><paramtype><classname>notation</classname></paramtype></parameter></function>
|
|
</namespace>
|
|
</namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/printf.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="printf"><inherit access="public">cnvbase</inherit><typedef name="this_type"><type><classname>boost::cnv::printf</classname></type></typedef>
|
|
<typedef name="base_type"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<data-member name="CONVERT_FUNC_SET_BASE"><type/></data-member>
|
|
<data-member name="CONVERT_FUNC_SET_PRECISION"><type/></data-member>
|
|
<data-member name="CONVERT_FUNC_SET_UPPERCASE"><type/></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="operator()" cv="const"><type>boost::disable_if< cnv::is_any_string< TypeIn >, void >::type</type><template>
|
|
<template-type-parameter name="TypeIn"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< std::string > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>boost::disable_if< cnv::is_any_string< TypeOut >, void >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
</template><parameter name="value_in"><paramtype>std::string const &</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< TypeOut > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>boost::disable_if< cnv::is_any_string< TypeOut >, void >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
</template><parameter name="value_in"><paramtype>char const *</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< TypeOut > &</paramtype></parameter></method>
|
|
</method-group>
|
|
<method-group name="private member functions">
|
|
<method name="pos" cv="const"><type>int</type><template>
|
|
<template-type-parameter name="Type"/>
|
|
</template></method>
|
|
<method name="format" cv="const"><type>char const *</type><parameter name="pos"><paramtype>int</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct></namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/spirit.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="spirit"><method-group name="public member functions">
|
|
<method name="parse_" cv="const"><type>void</type><template>
|
|
<template-type-parameter name="Iterator"/>
|
|
</template><parameter name="beg"><paramtype>Iterator</paramtype></parameter><parameter name="end"><paramtype>Iterator</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="str"><paramtype>std::string const &</paramtype></parameter><parameter name="result"><paramtype>boost::optional< int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="str"><paramtype>char const *</paramtype></parameter><parameter name="result"><paramtype>boost::optional< int > &</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct></namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/sstream.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="basic_stringstream"><template>
|
|
<template-type-parameter name="Char"/>
|
|
</template><typedef name="char_type"><type>Char</type></typedef>
|
|
<typedef name="this_type"><type><classname>boost::cnv::basic_stringstream</classname>< char_type ></type></typedef>
|
|
<typedef name="stream_type"><type>std::basic_stringstream< char_type ></type></typedef>
|
|
<typedef name="istream_type"><type>std::basic_istream< char_type ></type></typedef>
|
|
<typedef name="buffer_type"><type>std::basic_streambuf< char_type ></type></typedef>
|
|
<typedef name="parser_type"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<typedef name="string_type"><type>std::basic_string< char_type ></type></typedef>
|
|
<typedef name="manipulator_type"><type>std::ios_base &(*</type></typedef>
|
|
<method-group name="public member functions">
|
|
<method name="operator()" cv="const"><type>boost::enable_if_c<!cnv::is_any_string< TypeIn >::value, void >::type</type><template>
|
|
<template-type-parameter name="TypeIn"/>
|
|
</template><parameter name="value_in"><paramtype>TypeIn const &</paramtype></parameter><parameter name="string_out"><paramtype>boost::optional< string_type > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>boost::enable_if_c< cnv::is_any_string< StringIn >::value &&!cnv::is_any_string< TypeOut >::value, void >::type</type><template>
|
|
<template-type-parameter name="TypeOut"/>
|
|
<template-type-parameter name="StringIn"/>
|
|
</template><parameter name="string_in"><paramtype>StringIn const &</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< TypeOut > &</paramtype></parameter></method>
|
|
<method name="operator()"><type><classname>this_type</classname> &</type><parameter name="locale"><paramtype>std::locale const &</paramtype></parameter></method>
|
|
<method name="operator()"><type><classname>this_type</classname> &</type><parameter name="m"><paramtype>manipulator_type</paramtype></parameter></method>
|
|
<method name="operator()"><type><classname>this_type</classname> &</type><template>
|
|
<template-type-parameter name="Manipulator"/>
|
|
</template><parameter name="m"><paramtype>Manipulator</paramtype></parameter></method>
|
|
<method name="CONVERTER_PARAM_FUNC"><type/><parameter name=""><paramtype>locale</paramtype></parameter><parameter name=""><paramtype>std::locale</paramtype></parameter></method>
|
|
<method name="CONVERTER_PARAM_FUNC"><type/><parameter name=""><paramtype>precision</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
|
|
<method name="CONVERTER_PARAM_FUNC"><type/><parameter name=""><paramtype>uppercase</paramtype></parameter><parameter name=""><paramtype>bool</paramtype></parameter></method>
|
|
<method name="CONVERTER_PARAM_FUNC"><type/><parameter name=""><paramtype><classname>base</classname></paramtype></parameter><parameter name=""><paramtype>boost::cnv::base::type</paramtype></parameter></method>
|
|
<method name="CONVERTER_PARAM_FUNC"><type/><parameter name=""><paramtype><classname>notation</classname></paramtype></parameter><parameter name=""><paramtype>boost::cnv::notation::type</paramtype></parameter></method>
|
|
</method-group>
|
|
<constructor/>
|
|
</struct><typedef name="cstringstream"><type><classname>boost::cnv::basic_stringstream</classname>< char ></type></typedef>
|
|
<typedef name="wstringstream"><type><classname>boost::cnv::basic_stringstream</classname>< wchar_t ></type></typedef>
|
|
</namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/convert/strtol.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="cnv">
|
|
<struct name="strtol"><inherit access="public">cnvbase</inherit><typedef name="this_type"><type><classname>boost::cnv::strtol</classname></type></typedef>
|
|
<typedef name="base_type"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<data-member name="CONVERT_FUNC_SET_BASE"><type/></data-member>
|
|
<data-member name="CONVERT_FUNC_SET_PRECISION"><type/></data-member>
|
|
<data-member name="CONVERT_FUNC_SET_UPPERCASE"><type/></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="v"><paramtype>std::string const &</paramtype></parameter><parameter name="r"><paramtype>boost::optional< int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="v"><paramtype>std::string const &</paramtype></parameter><parameter name="r"><paramtype>boost::optional< long int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="v"><paramtype>std::string const &</paramtype></parameter><parameter name="r"><paramtype>boost::optional< unsigned long int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="v"><paramtype>std::string const &</paramtype></parameter><parameter name="r"><paramtype>boost::optional< double > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="value_in"><paramtype>char const *</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< double > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="value_in"><paramtype>char const *</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="value_in"><paramtype>char const *</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< long int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="value_in"><paramtype>char const *</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< unsigned long int > &</paramtype></parameter></method>
|
|
<method name="operator()" cv="const"><type>void</type><parameter name="value_in"><paramtype>int</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional< std::string > &</paramtype></parameter></method>
|
|
</method-group>
|
|
<method-group name="public static functions">
|
|
<method name="ltostr" specifiers="static"><type>std::string</type><parameter name="num"><paramtype>long int</paramtype></parameter><parameter name="base"><paramtype>unsigned int</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct></namespace>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/make_default.hpp">
|
|
<namespace name="boost">
|
|
|
|
|
|
|
|
|
|
|
|
<function name="make_default"><type>T</type><template>
|
|
<template-type-parameter name="T"/>
|
|
</template></function>
|
|
</namespace>
|
|
</header>
|
|
</library-reference>
|