#include <string_writer.h>

Definition

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

Namespace: xtd::io

Library: xtd.core

Public Member Functions
	string_writer ()=default
	Initializes a new instance of the stream_writer class .

	string_writer (const xtd::ustring &str)
	Initializes a new instance of the stream_writer class for the specified string.

const std::ostream &	base_stream () const noexcept
	Returns the underlying stream.

std::ostream &	base_stream () noexcept
	Returns the underlying stream.

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

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

void	write (const xtd::ustring &value) override
	Writes the specified string 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

◆ string_writer() [1/2]

xtd::io::string_writer::string_writer ( )

default

Initializes a new instance of the stream_writer class .

◆ string_writer() [2/2]

xtd::io::string_writer::string_writer ( const xtd::ustring & str )

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

Parameters

str	base string.

Member Function Documentation

◆ base_stream() [1/2]

const std::ostream & xtd::io::string_writer::base_stream ( ) const

noexcept

Returns the underlying stream.

Returns: The underlying stream.

◆ base_stream() [2/2]

std::ostream & xtd::io::string_writer::base_stream ( )

noexcept

Returns the underlying stream.

Returns: The underlying stream.

◆ flush()

void xtd::io::string_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.

◆ to_string()

xtd::ustring xtd::io::string_writer::to_string ( ) const

overridevirtualnoexcept

Returns a std::string that represents the current object.

Returns: A string that represents the current object.

Examples: The following code example demonstrates what to_string returns.

Reimplemented from xtd::object.

◆ write()

void xtd::io::string_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.