Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
std::basic_stringbuf(3)	      C++ Standard Libary      std::basic_stringbuf(3)

NAME
       std::basic_stringbuf - std::basic_stringbuf

Synopsis
	  Defined in header <sstream>
	  template<

	  class	CharT,
	  class	Traits = std::char_traits<CharT>,
	  class	Allocator = std::allocator<CharT>

	  > class basic_stringbuf : public std::basic_streambuf<CharT, Traits>

	  std::basic_stringbuf	is  a  std::basic_streambuf  whose  associated
       character sequence
	  is a memory-resident sequence	of arbitrary characters, which can  be
       initialized from
	  or made available as an instance of std::basic_string.

	  Typical  implementations  of	std::basic_stringbuf hold an object of
       type
	  std::basic_string or equivalent resizeable  sequence	container  di-
       rectly as a data
	  member and use it as both the	controlled character sequence (the ar-
       ray where the six
	  pointers of std::basic_streambuf are pointing	to) and	as the associ-
       ated character
	  sequence  (the source	of characters for all input operations and the
       target for the
	  output).

	  In addition, a typical implementation	holds a	data member of type
	  std::ios_base::openmode to indicate the status of the	stream (input-
       only,
	  output-only, input/output, at-end, etc).

	  if over-allocation strategy is used by overflow(), an	additional
	  high-watermark pointer may be	stored to track	the  last  initialized
       (since C++11)
	  character.

	  Two specializations for common character types are also defined:

	  Defined in header <sstream>
	  Type	     Definition
	  stringbuf  basic_stringbuf<char>
	  wstringbuf basic_stringbuf<wchar_t>

Member types
	  Member type	 Definition
	  char_type	 CharT
	  traits_type	    Traits;    the    program	 is    ill-formed   if
       Traits::char_type is not	CharT.
	  int_type	 Traits::int_type
	  pos_type	 Traits::pos_type
	  off_type	 Traits::off_type
	  allocator_type Allocator

Member functions
Public member functions
	  constructor			  constructs a basic_stringbuf object
					  (public member function)
	  operator=			  assigns a basic_stringbuf object
	  (C++11)			  (public member function)
	  swap				  swaps	two basic_stringbuf objects
	  (C++11)			  (public member function)
	  destructor			  destructs a  basic_stringbuf	object
       and the string it
	  [virtual] (implicitly	declared) holds
					  (virtual public member function)
					  replaces  or	obtains	 a copy	of the
       associated
	  str				  character string
					  (public member function)
	  get_allocator			  obtains a copy of the	allocator  as-
       sociated	with the
	  (C++20)			  internal sequence container
					  (public member function)
	  view				   obtains  a view over	the underlying
       character
	  (C++20)			  sequence
					  (public member function)

Protected member functions
	  underflow			  returns the next character available
       in the input
	  [virtual]			  sequence
					  (virtual protected member function)
	  pbackfail			  puts a character back	into the input
       sequence
	  [virtual]			  (virtual protected member function)
	  overflow			  appends a character  to  the	output
       sequence
	  [virtual]			  (virtual protected member function)
	  setbuf			   attempts  to	replace	the controlled
       character
	  [virtual]			  sequence with	an array
					  (virtual protected member function)
	  seekoff			  repositions the next pointer in  the
       input sequence,
	  [virtual]			  output sequence, or both, using rel-
       ative addressing
					  (virtual protected member function)
	  seekpos			   repositions the next	pointer	in the
       input sequence,
	  [virtual]			  output sequence, or both  using  ab-
       solute addressing
					  (virtual protected member function)

Non-member functions
	  std::swap(std::basic_stringbuf) specializes the std::swap algorithm
	  (C++11)			  (function template)

       Inherited from std::basic_streambuf

Member types
	  Member type Definition
	  char_type   CharT
	  traits_type  Traits;	the program is ill-formed if Traits::char_type
       is not CharT.
	  int_type    Traits::int_type
	  pos_type    Traits::pos_type
	  off_type    Traits::off_type

Member functions
	  destructor	     destructs the basic_streambuf object
	  [virtual]	     (virtual public member function of
			     std::basic_streambuf<CharT,Traits>)

Locales
	  pubimbue	     invokes imbue()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  getloc	     obtains a copy of the associated locale
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)

Positioning
	  pubsetbuf	     invokes setbuf()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  pubseekoff	     invokes seekoff()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  pubseekpos	     invokes seekpos()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  pubsync	     invokes sync()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)

Get area
			     obtains  the  number  of  characters  immediately
       available in the	get
	  in_avail	     area
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
			     advances the input	sequence, then reads one char-
       acter without
	  snextc	     advancing again
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  sbumpc	      reads  one character from	the input sequence and
       advances	the
	  stossc	     sequence
	  (removed in C++17) (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
			     reads one character from the input	sequence with-
       out advancing the
	  sgetc		     sequence
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  sgetn		     invokes xsgetn()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)

Put area
			     writes one	character to the put area and advances
       the next
	  sputc		     pointer
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  sputn		     invokes xsputn()
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)

Putback
	  sputbackc	     puts one character	back in	the input sequence
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)
	  sungetc	     moves the next pointer in the input sequence back
       by one
			     (public  member  function	of  std::basic_stream-
       buf<CharT,Traits>)

Protected member functions
	  constructor	constructs a basic_streambuf object
			(protected member function)
	  operator=	replaces a basic_streambuf object
	  (C++11)	(protected member function)
	  swap		swaps two basic_streambuf objects
	  (C++11)	(protected member function)

Locales
	  imbue		changes	the associated locale
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)

Positioning
	  setbuf	 replaces  the buffer with user-defined	array, if per-
       mitted
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
			repositions the	next pointer in	 the  input  sequence,
       output sequence,
	  seekoff	or both, using relative	addressing
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
			repositions  the  next	pointer	in the input sequence,
       output sequence,
	  seekpos	or both	using absolute addressing
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  sync		synchronizes the buffers with the associated character
       sequence
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)

Get area
			obtains	the number of characters available  for	 input
       in the associated
	  showmanyc	input sequence,	if known
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  underflow	reads characters from the associated input sequence to
       the get area
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
			reads characters from the associated input sequence to
       the get area
	  uflow		and advances the next pointer
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  xsgetn	reads multiple characters from the input sequence
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  eback		 returns a pointer to the beginning, current character
       and the end of
	  gptr		the get	area
	  egptr		(protected member function)
	  gbump		advances the next pointer in the input sequence
			(protected member function)
			repositions the	beginning, next, and end  pointers  of
       the input
	  setg		sequence
			(protected member function)

Put area
	  xsputn	writes multiple	characters to the output sequence
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  overflow	 writes	 characters  to	the associated output sequence
       from the	put area
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)
	  pbase		returns	a pointer to the beginning, current  character
       and the end of
	  pptr		the put	area
	  epptr		(protected member function)
	  pbump		advances the next pointer of the output	sequence
			(protected member function)
			repositions  the  beginning, next, and end pointers of
       the output
	  setp		sequence
			(protected member function)

Putback
			puts a character back into the input sequence,	possi-
       bly modifying the
	  pbackfail	input sequence
	  [virtual]	(virtual protected member function of
			std::basic_streambuf<CharT,Traits>)

http://cppreference.com		  2022.07.31	       std::basic_stringbuf(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::basic_stringbuf&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help