mirror of
https://github.com/boostorg/variant.git
synced 2026-02-17 14:12:12 +00:00
113 lines
3.8 KiB
XML
113 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
|
|
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
|
<header name="boost/variant/apply_visitor.hpp">
|
|
<namespace name="boost">
|
|
<overloaded-function name="apply_visitor">
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="Visitor"/>
|
|
<template-type-parameter name="T1"/>
|
|
<template-type-parameter name="T2"/>
|
|
<template-varargs/>
|
|
<template-type-parameter name="TN"/>
|
|
</template>
|
|
|
|
<type>typename Visitor::result_type</type>
|
|
|
|
<parameter name="visitor">
|
|
<paramtype>Visitor &</paramtype>
|
|
</parameter>
|
|
<parameter name="operand">
|
|
<paramtype><classname>variant</classname><T1, T2, ..., TN> &</paramtype>
|
|
</parameter>
|
|
</signature>
|
|
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="Visitor"/>
|
|
<template-type-parameter name="T1"/>
|
|
<template-type-parameter name="T2"/>
|
|
<template-varargs/>
|
|
<template-type-parameter name="TN"/>
|
|
</template>
|
|
|
|
<type>typename Visitor::result_type</type>
|
|
|
|
<parameter name="visitor">
|
|
<paramtype>Visitor &</paramtype>
|
|
</parameter>
|
|
<parameter name="operand">
|
|
<paramtype>const <classname>variant</classname><T1, T2, ..., TN> &</paramtype>
|
|
</parameter>
|
|
</signature>
|
|
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="Visitor"/>
|
|
<template-type-parameter name="T1"/>
|
|
<template-type-parameter name="T2"/>
|
|
<template-varargs/>
|
|
<template-type-parameter name="TN"/>
|
|
</template>
|
|
|
|
<type>typename Visitor::result_type</type>
|
|
|
|
<parameter name="visitor">
|
|
<paramtype>const Visitor &</paramtype>
|
|
</parameter>
|
|
<parameter name="operand">
|
|
<paramtype><classname>variant</classname><T1, T2, ..., TN> &</paramtype>
|
|
</parameter>
|
|
</signature>
|
|
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="Visitor"/>
|
|
<template-type-parameter name="T1"/>
|
|
<template-type-parameter name="T2"/>
|
|
<template-varargs/>
|
|
<template-type-parameter name="TN"/>
|
|
</template>
|
|
|
|
<type>typename Visitor::result_type</type>
|
|
|
|
<parameter name="visitor">
|
|
<paramtype>const Visitor &</paramtype>
|
|
</parameter>
|
|
<parameter name="operand">
|
|
<paramtype>const <classname>variant</classname><T1, T2, ..., TN> &</paramtype>
|
|
</parameter>
|
|
</signature>
|
|
|
|
<purpose>
|
|
<simpara>Allows compile-time checked type-safe application of the
|
|
given visitor to the content of the given variant, ensuring that all
|
|
types are handled by the visitor.</simpara>
|
|
</purpose>
|
|
|
|
<description>
|
|
<simpara>Invokes the function call operator of the given visitor on the
|
|
content of the given <code><classname>variant</classname></code>.</simpara>
|
|
</description>
|
|
|
|
<returns>
|
|
<simpara>Returns the result of applying the given visitor to the
|
|
content of the given
|
|
<code><classname>variant</classname></code>.</simpara>
|
|
</returns>
|
|
|
|
<requires>
|
|
<simpara>The given visitor must fulfill the
|
|
<link linkend="variant.concepts.static-visitor"><emphasis>StaticVisitor</emphasis></link>
|
|
concept requirements with respect to each of the bounded types of the
|
|
given <code>variant</code>.</simpara>
|
|
</requires>
|
|
|
|
<throws>
|
|
<simpara>Throws if the given visitor throws when applied to the
|
|
content of the given <code><classname>variant</classname></code>.</simpara>
|
|
</throws>
|
|
</overloaded-function>
|
|
</namespace>
|
|
</header> |