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

NAME
     std::basic_ospanstream - std::basic_ospanstream

Synopsis
	Defined in header <spanstream>
	template<

	    class CharT,
	    class Traits = std::char_traits<CharT>  (since C++23)
	> class basic_ospanstream

	    : public basic_ostream<CharT, Traits>

	The  class  template std::basic_ospanstream implements output operations
     on streams
	based on fixed buffers.

	At the low level, the class essentially wraps a raw  device  implementa-
     tion of
	std::basic_spanbuf  into a higher-level interface of std::basic_ostream.
     The complete
	interface to unique std::basic_spanbuf members is provided.

	std-basic ospanstream-inheritance.svg

					Inheritance diagram

	Several typedefs for common character types are provided:

	Defined in header <spanstream>
	Type		  Definition
	std::ospanstream  std::basic_ospanstream<char>
	std::wospanstream std::basic_ospanstream<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

	Data members

	Member object Definition
	sb (private)  The wrapped std::basic_spanbuf.
		      (exposition-only member object*)

Member functions
	constructor	  constructs the basic_ospanstream
	(C++23) 	  (public member function)
	destructor	  destroys the basic_ospanstream
	[virtual] (C++23) (virtual public member function)
	operator=	  move-assignments the basic_ospanstream
	(C++23) 	  (public member function)
	swap		  swaps two basic_ospanstream objects
	(C++23) 	  (public member function)
	rdbuf		  obtains the address of the wrapped raw span device ob-
     ject
	(C++23) 	  (public member function)
	      Underlying buffer operations
	span		  gets or sets the underlying buffer of the wrapped span
     device
	(C++23) 	  object
			  (public member function)

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

     Inherited from std::basic_ostream

Member functions
Formatted output
	operator<< inserts formatted data
		   (public member function of std::basic_ostream<CharT,Traits>)

Unformatted output
	put	   inserts a character
		   (public member function of std::basic_ostream<CharT,Traits>)
	write	   inserts blocks of characters
		   (public member function of std::basic_ostream<CharT,Traits>)

Positioning
	tellp	   returns the output position indicator
		   (public member function of std::basic_ostream<CharT,Traits>)
	seekp	   sets the output position indicator
		   (public member function of std::basic_ostream<CharT,Traits>)

Miscellaneous
	flush	   synchronizes with the underlying storage device
		   (public member function of std::basic_ostream<CharT,Traits>)

Member classes
	sentry	implements  basic logic for preparation of the stream for output
     operations
	       (public member class of std::basic_ostream<CharT,Traits>)

     Inherited from std::basic_ios

Member types
	Member type Definition
	char_type   CharT
	traits_type Traits
	int_type    Traits::int_type
	pos_type    Traits::pos_type
	off_type    Traits::off_type

Member functions
State functions
	good	      checks if no error has occurred i.e.  I/O  operations  are
     available
		      (public member function of std::basic_ios<CharT,Traits>)
	eof	      checks if end-of-file has been reached
		      (public member function of std::basic_ios<CharT,Traits>)
	fail	      checks if an error has occurred
		      (public member function of std::basic_ios<CharT,Traits>)
	bad	      checks if a non-recoverable error has occurred
		      (public member function of std::basic_ios<CharT,Traits>)
	operator!     checks if an error has occurred (synonym of fail())
		      (public member function of std::basic_ios<CharT,Traits>)
	operator bool checks if no error has occurred (synonym of !fail())
		      (public member function of std::basic_ios<CharT,Traits>)
	rdstate       returns state flags
		      (public member function of std::basic_ios<CharT,Traits>)
	setstate      sets state flags
		      (public member function of std::basic_ios<CharT,Traits>)
	clear	      modifies state flags
		      (public member function of std::basic_ios<CharT,Traits>)

Formatting
	copyfmt       copies formatting information
		      (public member function of std::basic_ios<CharT,Traits>)
	fill	      manages the fill character
		      (public member function of std::basic_ios<CharT,Traits>)

Miscellaneous
	exceptions    manages exception mask
		      (public member function of std::basic_ios<CharT,Traits>)
	imbue	      sets the locale
		      (public member function of std::basic_ios<CharT,Traits>)
	rdbuf	      manages associated stream buffer
		      (public member function of std::basic_ios<CharT,Traits>)
	tie	      manages tied stream
		      (public member function of std::basic_ios<CharT,Traits>)
	narrow	      narrows characters
		      (public member function of std::basic_ios<CharT,Traits>)
	widen	      widens characters
		      (public member function of std::basic_ios<CharT,Traits>)

     Inherited from std::ios_base

Member functions
Formatting
	flags		  manages format flags
			  (public member function of std::ios_base)
	setf		  sets specific format flag
			  (public member function of std::ios_base)
	unsetf		  clears specific format flag
			  (public member function of std::ios_base)
	precision	  manages decimal precision of floating point operations
			  (public member function of std::ios_base)
	width		  manages field width
			  (public member function of std::ios_base)

Locales
	imbue		  sets locale
			  (public member function of std::ios_base)
	getloc		  returns current locale
			  (public member function of std::ios_base)

Internal extensible array
	xalloc		   returns a program-wide unique integer that is safe to
     use as index
	[static]	  to pword() and iword()
			  (public static member function of std::ios_base)
			  resizes the private storage if necessary and access to
     the long
	iword		  element at the given index
			  (public member function of std::ios_base)
			  resizes the private storage if necessary and access to
     the void*
	pword		  element at the given index
			  (public member function of std::ios_base)

Miscellaneous
	register_callback registers event callback function
			  (public member function of std::ios_base)
	sync_with_stdio   sets whether C++ and C I/O libraries are interoperable
	[static]	  (public static member function of std::ios_base)

Member classes
	failure 	  stream exception
			  (public member class of std::ios_base)
	Init		  initializes standard stream objects
			  (public member class of std::ios_base)

Member types and constants
	Type	       Explanation
		       stream open mode type

		       The following constants are also defined:

		       Constant 	 Explanation
		       app		 seek to the end of stream  before  each
     write
		       binary		 open in binary mode
	openmode       in		 open for reading
		       out		 open for writing
		       trunc		 discard the contents of the stream when
					 opening
		       ate		  seek	to the end of stream immediately
     after
					 open
		       noreplace (C++23) open in exclusive mode

		       (typedef)
		       formatting flags type

		       The following constants are also defined:

		       Constant    Explanation
		       dec	    use  decimal  base	for  integer  I/O:   see
     std::dec
		       oct	   use octal base for integer I/O: see std::oct
		       hex	    use  hexadecimal  base  for integer I/O: see
     std::hex
		       basefield   dec | oct | hex. Useful  for  masking  opera-
     tions
		       left	    left adjustment (adds fill characters to the
     right): see
				   std::left
		       right	   right adjustment (adds fill characters to the
     left): see
				   std::right
		       internal    internal adjustment (adds fill characters  to
     the internal
				   designated point): see std::internal
		       adjustfield left | right | internal. Useful for masking
				   operations
				   generate  floating  point  types using scien-
     tific notation,
		       scientific  or hex notation if combined with fixed: see
				   std::scientific
	fmtflags		   generate floating point types using fixed no-
     tation, or
		       fixed	   hex notation if combined with scientific: see
				   std::fixed
		       floatfield  scientific | fixed. Useful for masking opera-
     tions
		       boolalpha   insert and extract bool type in  alphanumeric
     format: see
				   std::boolalpha
				   generate a prefix indicating the numeric base
     for integer
		       showbase     output,  require  the  currency indicator in
     monetary I/O:
				   see std::showbase
		       showpoint   generate a decimal-point  character	uncondi-
     tionally for
				   floating-point  number output: see std::show-
     point
		       showpos	   generate a + character for  non-negative  nu-
     meric output:
				   see std::showpos
		       skipws	    skip leading whitespace before certain input
     operations:
				   see std::skipws
		       unitbuf	   flush the output after each output operation:
     see
				   std::unitbuf
				   replace certain lowercase letters with  their
     uppercase
		       uppercase   equivalents in certain output operations: see
				   std::uppercase

		       (typedef)
		       state of the stream type

		       The following constants are also defined:

		       Constant Explanation
	iostate        goodbit	no error
		       badbit	irrecoverable stream error
		       failbit	input/output operation failed (formatting or ex-
     traction
				error)
		       eofbit	 associated  input  sequence has reached end-of-
     file

		       (typedef)
		       seeking direction type

		       The following constants are also defined:

	seekdir        Constant Explanation
		       beg	the beginning of a stream
		       end	the ending of a stream
		       cur	the current position of stream position  indica-
     tor

		       (typedef)
	event	       specifies event type
		       (enum)
	event_callback callback function type
		       (typedef)

Notes
	 Feature-test macro   Value    Std		Feature
	__cpp_lib_spanstream 202106L (C++23) std::spanbuf, std::spanstream

http://cppreference.com 	   2024.06.10	       std::basic_ospanstream(3)

home | help