-
Notifications
You must be signed in to change notification settings - Fork 116
/
filter_test.html
129 lines (89 loc) · 5.69 KB
/
filter_test.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Filter Testing Functions</TITLE>
<LINK REL="stylesheet" HREF="../../../../boost.css">
<LINK REL="stylesheet" HREF="../theme/iostreams.css">
</HEAD>
<BODY>
<!-- Begin Banner -->
<H1 CLASS="title">Filter Testing Functions</H1>
<HR CLASS="banner">
<!-- End Banner -->
<DL class="page-index">
<DT><A href="#overview">Overview</A></DT>
<DT><A href="#headers">Headers</A></DT>
<DT><A href="#reference">Reference</A>
<DL>
<DT><A href="#test_input">Function template <CODE>test_input_filter</CODE></A></DT>
<DT><A href="#test_output">Function template <CODE>test_output_filter</CODE></A></DT>
<DT><A href="#test_pair">Function template <CODE>test_filter_pair</CODE></A></DT>
</DL>
</DT>
</DL>
<HR>
<A NAME="overview"></A>
<H2>Overview</H2>
<P>
The header <A CLASS="header" HREF="../../../../boost/iostreams/filter/test.hpp"><CODE><boost/iostreams/filter/test.hpp></CODE></A> provides several overloaded function templates for verifying that a filter works as expected when used in conjunction with non-<A HREF='../concepts/blocking.html'>Blocking</A> <A HREF='../concepts/source.html'>Sources</A> and <A HREF='../concepts/sink.html'>Sinks</A>.
</P>
<A NAME="headers"></A>
<H2>Headers</H2>
<DL class="page-index">
<DT><A CLASS="header" HREF="../../../../boost/iostreams/filter/test.hpp"><CODE><boost/iostreams/filter/test.hpp></CODE></A></DT>
</DL>
<A NAME="reference"></A>
<H2>Reference</H2>
<A NAME="test_input"></A>
<H3>Function template <CODE>test_input_filter</CODE></H3>
<H4>Description</H4>
<P>Verifies that the given <A HREF='../concepts/input_filter.html'>InputFilter</A> yields the given output when passed the given input.</P>
<H4>Synopsis</H4>
<PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> InputFilter>
<SPAN CLASS='keyword'>bool</SPAN> test_input_filter( InputFilter filter,
<SPAN CLASS='keyword'>const</SPAN> std::string& input,
<SPAN CLASS='keyword'>const</SPAN> std::string& output );
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> InputFilter, <SPAN CLASS='keyword'>typename</SPAN> Source1, <SPAN CLASS='keyword'>typename</SPAN> Source2>
<SPAN CLASS='keyword'>bool</SPAN> test_input_filter( InputFilter filter,
<SPAN CLASS='keyword'>const</SPAN> Source1& input,
<SPAN CLASS='keyword'>const</SPAN> Source2& output );
} } <SPAN CLASS='comment'>// End namespace boost::io</SPAN></PRE>
<A NAME="test_output"></A>
<H3>Function template <CODE>test_output_filter</CODE></H3>
<H4>Description</H4>
<P>Verifies that the given <A HREF='../concepts/output_filter.html'>OutputFilter</A> yields the given output when passed the given input.</P>
<H4>Synopsis</H4>
<PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> OutputFilter>
<SPAN CLASS='keyword'>bool</SPAN> test_output_filter( OutputFilter filter,
<SPAN CLASS='keyword'>const</SPAN> std::string& input,
<SPAN CLASS='keyword'>const</SPAN> std::string& output );
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> OutputFilter, <SPAN CLASS='keyword'>typename</SPAN> Source1, <SPAN CLASS='keyword'>typename</SPAN> Source2>
<SPAN CLASS='keyword'>bool</SPAN> test_output_filter( OutputFilter filter,
<SPAN CLASS='keyword'>const</SPAN> Source1& input,
<SPAN CLASS='keyword'>const</SPAN> Source2& output );
} } <SPAN CLASS='comment'>// End namespace boost::io</SPAN></PRE>
<A NAME="test_pair"></A>
<H3>Function template <CODE>test_filter_pair</CODE></H3>
<H4>Description</H4>
<P>Verifies that the given data is preserved when it is passed first through a given <A HREF='../concepts/output_filter.html'>OutputFilter</A> and then through a given <A HREF='../concepts/input_filter.html'>InputFilter</A>.</P>
<H4>Synopsis</H4>
<PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> OutputFilter, <SPAN CLASS='keyword'>typename</SPAN> InputFilter>
<SPAN CLASS='keyword'>bool</SPAN> test_filter_pair( OutputFilter first,
InputFilter second,
<SPAN CLASS='keyword'>const</SPAN> std::string& data );
<SPAN CLASS='keyword'>template</SPAN><<SPAN CLASS='keyword'>typename</SPAN> OutputFilter, <SPAN CLASS='keyword'>typename</SPAN> InputFilter, <SPAN CLASS='keyword'>typename</SPAN> Source>
<SPAN CLASS='keyword'>bool</SPAN> test_filter_pair( OutputFilter first,
InputFilter second,
<SPAN CLASS='keyword'>const</SPAN> Source& data );
} } <SPAN CLASS='comment'>// End namespace boost::io</SPAN></PRE>
<!-- Begin Footer -->
<HR>
<P CLASS="copyright">© Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>© Copyright 2004-2007 <a href="https://www.boost.org/users/people/jonathan_turkanis.html" target="_top">Jonathan Turkanis</a></P>
<P CLASS="copyright">
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <A HREF="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>)
</P>
<!-- End Footer -->
</BODY>