#include <stream_writer.h>

Definition

Implements a xtd::io::text_writer for writing characters to a stream.

Namespace: xtd::io

Library: xtd.core

Public Member Functions
	stream_writer (const xtd::ustring &path)
	Initializes a new instance of the stream_writer class for the specified file name.

	stream_writer (const xtd::ustring &path, bool append)
	Initializes a new instance of the System::IO::StreamWriter class for the specified file on the specified path, using the default encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.

	stream_writer (std::ostream &stream)
	Initializes a new instance of the stream_writer class for the specified stream.

	stream_writer (std::ostream &stream, bool append)
	Initializes a new instance of the stream_writer class for the specified stream.

bool	auto_flush () const

void	auto_flush (bool auto_flush)

std::optional< std::reference_wrapper< std::ostream > >	base_stream () const
	Returns the underlying stream.

void	close () override
	Closes the stream_writer object and the underlying stream, and releases any system resources associated with the reader.

void	flush () override
	Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

void	write (bool value)
	Writes the specified bool value to the text stream.

template<typename ... args_t>
void	write (const xtd::ustring &fmt, args_t &&... args) noexcept
	Writes the specified arguments with specified format to the text stream.

virtual void	write (const xtd::ustring &value)
	Writes the specified string value to the text stream.

void	write (const xtd::ustring &value) override
	Writes the specified string value to the text stream.

void	write (double value)
	Writes the specified double value to the text stream.

void	write (float value)
	Writes the specified float value to the text stream.

void	write (int16_t value)
	Writes the specified int16_t value to the text stream.

void	write (int32_t value)
	Writes the specified int32_t value to the text stream.

void	write (int64_t value)
	Writes the specified int64_t value to the text stream.

void	write (int8_t value)
	Writes the specified int8_t value to the text stream.

void	write (uint16_t value)
	Writes the specified uint16_t value to the text stream.

void	write (uint32_t value)
	Writes the specified uint32_t value to the text stream.

void	write (uint64_t value)
	Writes the specified uint64_t value to the text stream.

void	write (uint8_t value)
	Writes the specified uint8_t value to the text stream.

template<typename value_t >
void	write (value_t value)
	Writes the specified value_t value to the text stream.

Public Member Functions inherited from xtd::io::text_writer
virtual void	close ()
	Closes the xtd::io::text_reader and releases any system resources associated with the text_reader.

virtual void	flush ()
	Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

const xtd::ustring &	new_line () const noexcept
	Gets the line terminator string used by the current text_writer.

void	new_line (const xtd::ustring &new_line) noexcept
	Sets the line terminator string used by the current text_writer.

void	write (bool value)
	Writes the specified bool value to the text stream.

template<typename ... args_t>
void	write (const xtd::ustring &fmt, args_t &&... args) noexcept
	Writes the specified arguments with specified format to the text stream.

virtual void	write (const xtd::ustring &value)
	Writes the specified string value to the text stream.

void	write (double value)
	Writes the specified double value to the text stream.

void	write (float value)
	Writes the specified float value to the text stream.

void	write (int16_t value)
	Writes the specified int16_t value to the text stream.

void	write (int32_t value)
	Writes the specified int32_t value to the text stream.

void	write (int64_t value)
	Writes the specified int64_t value to the text stream.

void	write (int8_t value)
	Writes the specified int8_t value to the text stream.

void	write (uint16_t value)
	Writes the specified uint16_t value to the text stream.

void	write (uint32_t value)
	Writes the specified uint32_t value to the text stream.

void	write (uint64_t value)
	Writes the specified uint64_t value to the text stream.

void	write (uint8_t value)
	Writes the specified uint8_t value to the text stream.

template<typename value_t >
void	write (value_t value)
	Writes the specified value_t value to the text stream.

void	write_line ()
	Writes new line to the text stream.

void	write_line (bool value)
	Writes the specified bool value and new line to the text stream.

template<typename ... args_t>
void	write_line (const xtd::ustring &fmt, args_t &&... args) noexcept
	Writes the specified arguments with specified format to the text stream.

void	write_line (const xtd::ustring &value)
	Writes the specified string value and new line to the text stream.

void	write_line (double value)
	Writes the specified double value and new line to the text stream.

void	write_line (float value)
	Writes the specified float value and new line to the text stream.

void	write_line (int16_t value)
	Writes the specified int16_t value and new line to the text stream.

void	write_line (int32_t value)
	Writes the specified int32_t value and new line to the text stream.

void	write_line (int64_t value)
	Writes the specified int64_t value and new line to the text stream.

void	write_line (int8_t value)
	Writes the specified int8_t value and new line to the text stream.

void	write_line (uint16_t value)
	Writes the specified uint16_t value and new line to the text stream.

void	write_line (uint32_t value)
	Writes the specified uint32_t value and new line to the text stream.

void	write_line (uint64_t value)
	Writes the specified uint64_t value and new line to the text stream.

void	write_line (uint8_t value)
	Writes the specified uint8_t value and new line to the text stream.

template<typename value_t >
void	write_line (value_t value)
	Writes the specified value_t value and new line to the text stream.

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.

virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.

virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Member Functions inherited from xtd::io::text_writer
static null_text_writer &	null () noexcept
	Provides a text_writer with no backing store that can be written to, but not read from.

static synchronized_text_writer	synchronised (text_writer &writer) noexcept
	Creates a thread-safe (synchronized) wrapper around the specified text_writer object.

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Protected Attributes inherited from xtd::io::text_writer
xtd::ustring	new_line_

Protected Member Functions inherited from xtd::io::text_writer
	text_writer ()=default
	Initializes a new instance of the xtd::io::text_writer class.

Constructor & Destructor Documentation

◆ stream_writer() [1/4]

xtd::io::stream_writer::stream_writer ( const xtd::ustring & path )

Initializes a new instance of the stream_writer class for the specified file name.

Parameters

path	The complete file path to be read.

Exceptions

xtd::argument_exception	path contains one or more of the invalid characters -or- The system could not retrieve the absolute path.
xtd::io::io_exception	the handle of the specified file cannot be opened

◆ stream_writer() [2/4]

xtd::io::stream_writer::stream_writer ( std::ostream & stream )

Initializes a new instance of the stream_writer class for the specified stream.

Parameters

stream The stream to be read.

◆ stream_writer() [3/4]

xtd::io::stream_writer::stream_writer	(	const xtd::ustring &	path,
		bool	append
	)

Initializes a new instance of the System::IO::StreamWriter class for the specified file on the specified path, using the default encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.

Parameters

path	The complete file path to write to.
append	Determines whether data is to be appended to the file. If the file exists and append is false, the file is overwritten. If the file exists and append is true, the data is appended to the file. Otherwise, a new file is created.

Exceptions

xtd::argument_exception	path contains one or more of the invalid characters -or- The system could not retrieve the absolute path.
xtd::io::io_exception	the handle of the specified file cannot be opened

◆ stream_writer() [4/4]

xtd::io::stream_writer::stream_writer	(	std::ostream &	stream,
		bool	append
	)

Initializes a new instance of the stream_writer class for the specified stream.

Parameters

stream The stream to be read.

Member Function Documentation

◆ base_stream()

std::optional< std::reference_wrapper< std::ostream > > xtd::io::stream_writer::base_stream ( ) const

Returns the underlying stream.

Returns: The underlying stream.

◆ close()

void xtd::io::stream_writer::close ( )

overridevirtual

Closes the stream_writer object and the underlying stream, and releases any system resources associated with the reader.

Reimplemented from xtd::io::text_writer.

◆ flush()

void xtd::io::stream_writer::flush ( )

overridevirtual

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Remarks: This default method does nothing, but derived classes can virtual the method to provide the appropriate functionality

Reimplemented from xtd::io::text_writer.

◆ write() [1/15]

void xtd::io::text_writer::write ( bool value )

Writes the specified bool value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [2/15]

template<typename ... args_t>

void xtd::io::text_writer::write	(	const xtd::ustring &	fmt,
		args_t &&...	args
	)

inlinenoexcept

Writes the specified arguments with specified format to the text stream.

Parameters

format	The arguments format to write.
args	The arguments to write with format

Exceptions

io::io_exception An I/O error occurs.

◆ write() [3/15]

virtual void xtd::io::text_writer::write ( const xtd::ustring & value )

virtual

Writes the specified string value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

Reimplemented from xtd::io::text_writer.

◆ write() [4/15]

void xtd::io::stream_writer::write ( const xtd::ustring & value )

overridevirtual

Writes the specified string value to the text stream.

Parameters

value The value to write

Exceptions

io::io_exception An I/O error occurs.

Reimplemented from xtd::io::text_writer.

◆ write() [5/15]

void xtd::io::text_writer::write ( double value )

Writes the specified double value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [6/15]

void xtd::io::text_writer::write ( float value )

Writes the specified float value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [7/15]

void xtd::io::text_writer::write ( int16_t value )

Writes the specified int16_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [8/15]

void xtd::io::text_writer::write ( int32_t value )

Writes the specified int32_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [9/15]

void xtd::io::text_writer::write ( int64_t value )

Writes the specified int64_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [10/15]

void xtd::io::text_writer::write ( int8_t value )

Writes the specified int8_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [11/15]

void xtd::io::text_writer::write ( uint16_t value )

Writes the specified uint16_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [12/15]

void xtd::io::text_writer::write ( uint32_t value )

Writes the specified uint32_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [13/15]

void xtd::io::text_writer::write ( uint64_t value )

Writes the specified uint64_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [14/15]

void xtd::io::text_writer::write ( uint8_t value )

Writes the specified uint8_t value to the text stream.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

◆ write() [15/15]

template<typename value_t >

void xtd::io::text_writer::write ( value_t value )

inline

Writes the specified value_t value to the text stream.

Template Parameters

value_t The type of value to write.

Parameters

value The value to write.

Exceptions

io::io_exception An I/O error occurs.

The documentation for this class was generated from the following file:

xtd.core/include/xtd/io/stream_writer.h

Definition

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ stream_writer() [1/4]

◆ stream_writer() [2/4]

◆ stream_writer() [3/4]

◆ stream_writer() [4/4]

Member Function Documentation

◆ base_stream()

◆ close()

◆ flush()

◆ write() [1/15]

◆ write() [2/15]

◆ write() [3/15]

◆ write() [4/15]

◆ write() [5/15]

◆ write() [6/15]

◆ write() [7/15]

◆ write() [8/15]

◆ write() [9/15]

◆ write() [10/15]

◆ write() [11/15]

◆ write() [12/15]

◆ write() [13/15]

◆ write() [14/15]

◆ write() [15/15]