Blame view

3rdparty/boost_1_81_0/libs/io/doc/nullstream.adoc 1.53 KB
73ef4ff3   Hu Chunming   提交三方库
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
  ////
  Copyright 2021 Glen Joseph Fernandes
  (glenjofe@gmail.com)
  
  Distributed under the Boost Software License, Version 1.0.
  (http://www.boost.org/LICENSE_1_0.txt)
  ////
  
  # Null Streams, <boost/io/nullstream.hpp>
  :toc:
  :toc-title:
  :idprefix:
  
  ## Description
  
  The header `<boost/io/nullstream.hpp>` provides the class template
  `boost::io::basic_nullbuf` which is a null stream buffer and class template
  `boost::io::basic_onullstream` which is a null stream.
  
  ## Example
  
  The following program passes a null stream to a function.
  
  ```
  #include <boost/io/ostream_joiner.hpp>
  #include <fstream>
  
  void setup(std::ostream& log);
  
  int main(int argc, char* argv[])
  {
      if (argc == 2) {
          std::ofstream file(argv[1]);
          setup(file);
      } else {
          boost::io::onullstream none;
          setup(none);
      }
  }
  ```
  
  ## Reference
  
  ### Header Synopsis
  
  ```
  namespace boost {
  namespace io {
  
  template<class CharT, class Traits = std::char_traits<Char> >
  class basic_nullbuf
      : public std::basic_streambuf<CharT, Traits> {
  protected:
      typename Traits::int_type overflow(typename Traits::int_type c) override;
  
      std::streamsize xsputn(const CharT*, std::streamsize n) override;
  };
  
  template<class CharT, class Traits = std::char_traits<CharT> >
  class basic_onullstream
      : public std::basic_ostream<CharT, Traits> {
  public:
      basic_onullstream();
  };
  
  typedef basic_onullstream<char> onullstream;
  typedef basic_onullstream<wchar_t> wonullstream;
  
  } // io
  } // boost
  ```
  
  ## Acknowledgments
  
  Glen Fernandes implemented `basic_nullbuf` and `basic_onullstream`.