dual_use_filter.html 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <HTML>
  3. <HEAD>
  4. <TITLE>DualUseFilter</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../../boost.css">
  6. <LINK REL="stylesheet" HREF="../theme/iostreams.css">
  7. </HEAD>
  8. <BODY>
  9. <!-- Begin Banner -->
  10. <H1 CLASS="title">DualUseFilter</H1>
  11. <HR CLASS="banner">
  12. <!-- End Banner -->
  13. <H2>Description</H2>
  14. <P>
  15. A DualUseFilter is a Filter which can act as an <A HREF="input_filter.html">InputFilter</A> or as an <A HREF="output_filter.html">OutputFilter</A>, but not as both simultaneously.
  16. </P>
  17. <P>
  18. DualUseFilters help reduce the number of different Filter types required to implement a particlar filtering algorithm. For example, by implementing <A HREF="../classes/regex_filter.html"><CODE>basic_regex_filter</CODE></A> as a DualUseFilter, the Iostreams library avoids having to define separate templates <CODE>basic_regex_input_filter</CODE> and <CODE>basic_regex_output_filter</CODE>.
  19. </P>
  20. <H2>Refinement of</H2>
  21. <P><A HREF="input_filter.html">InputFilter</A>, <A HREF="output_filter.html">OutputFilter</A>.</P>
  22. <H2>Associated Types</H2>
  23. <TABLE CELLPADDING="5" BORDER="1">
  24. <TR><TD>Character type</TD><TD>The type of the characters in the filtered sequences</TD></TR>
  25. <TR>
  26. <TD>Category</TD>
  27. <TD>
  28. A type convertible to <A HREF="../guide/traits.html#category_tags"><CODE>filter_tag</CODE></A> and to <A HREF="../guide/modes.html#mode_tags"><CODE>dual_use</CODE></A>
  29. </TD>
  30. </TR>
  31. <TR>
  32. <TD>Mode</TD>
  33. <TD>
  34. The unique <I>most-derived</I> <A HREF="../guide/modes.html#mode_tags">mode tag</A> to which Category is convertible
  35. </TD>
  36. </TR>
  37. </TABLE>
  38. <H2>Valid Expressions / Semantics</H2>
  39. Same as <A HREF="bidirectional_filter.html">BidirectionalFilter</A>.
  40. <H2>Exceptions</H2>
  41. Same as <A HREF="bidirectional_filter.html">BidirectionalFilter</A>.
  42. <H2>Models</H2>
  43. <UL>
  44. <LI>The <A HREF="../guide/text_processing.html">Text Processing Filters</A>.
  45. <LI>The compression and decompression filters, except for <A HREF="../classes/gzip.html#basic_gzip_decompressor"><CODE>basic_gzip_decompressor</CODE></A>.
  46. </UL>
  47. <!-- Begin Footer -->
  48. <HR>
  49. <P CLASS="copyright">&copy; Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>&copy; Copyright 2004-2007 <a href="https://www.boost.org/users/people/jonathan_turkanis.html" target="_top">Jonathan Turkanis</a></P>
  50. <P CLASS="copyright">
  51. 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>)
  52. </P>
  53. <!-- End Footer -->
  54. </BODY>