xtd::io::string_writer Class Reference

Inheritance diagram for xtd::io::string_writer:

Definition

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

class core_export_ string_writer : public xtd::io::text_writer

Inheritance

xtd::io::text_writer → xtd::io::string_writer

Header

#include <xtd/io/string_writer>

Namespace

xtd::io

Library

xtd.core

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

Public Properties
auto	base_stream () const noexcept -> const std::ostream &
	Returns the underlying stream.
auto	base_stream () noexcept -> std::ostream &
	Returns the underlying stream.

Public Methods
auto	flush () -> void override
	Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.
auto	write (const xtd::string &value) -> void override
	Writes the specified string value to the text stream.

Additional Inherited Members
auto	new_line () const noexcept -> const xtd::string &
	Gets the line terminator string used by the current text_writer.
auto	new_line (const xtd::string &new_line) noexcept -> void
	Sets the line terminator string used by the current text_writer.
virtual auto	close () -> void
	Closes the xtd::io::text_reader and releases any system resources associated with the text_reader.
auto	write (bool value) -> void
	Writes the specified bool value to the text stream.
auto	write (double value) -> void
	Writes the specified double value to the text stream.
auto	write (float value) -> void
	Writes the specified float value to the text stream.
auto	write (sbyte value) -> void
	Writes the specified sbyte value to the text stream.
auto	write (int16 value) -> void
	Writes the specified int16 value to the text stream.
auto	write (int32 value) -> void
	Writes the specified int32 value to the text stream.
auto	write (int64 value) -> void
	Writes the specified int64 value to the text stream.
auto	write (xtd::byte value) -> void
	Writes the specified xtd::byte value to the text stream.
auto	write (uint16 value) -> void
	Writes the specified uint16 value to the text stream.
auto	write (uint32 value) -> void
	Writes the specified uint32 value to the text stream.
auto	write (uint64 value) -> void
	Writes the specified uint64 value to the text stream.
template<class value_t>
auto	write (value_t value) -> void
	Writes the specified value_t value to the text stream.
template<class ... args_t>
auto	write (const xtd::string &fmt, args_t &&... args) noexcept -> void
	Writes the specified arguments with specified format to the text stream.
auto	write_line () -> void
	Writes new line to the text stream.
auto	write_line (const xtd::string &value) -> void
	Writes the specified string value and new line to the text stream.
auto	write_line (bool value) -> void
	Writes the specified bool value and new line to the text stream.
auto	write_line (double value) -> void
	Writes the specified double value and new line to the text stream.
auto	write_line (float value) -> void
	Writes the specified float value and new line to the text stream.
auto	write_line (sbyte value) -> void
	Writes the specified sbyte value and new line to the text stream.
auto	write_line (int16 value) -> void
	Writes the specified int16 value and new line to the text stream.
auto	write_line (int32 value) -> void
	Writes the specified int32 value and new line to the text stream.
auto	write_line (int64 value) -> void
	Writes the specified int64 value and new line to the text stream.
auto	write_line (xtd::byte value) -> void
	Writes the specified xtd::byte value and new line to the text stream.
auto	write_line (uint16 value) -> void
	Writes the specified uint16 value and new line to the text stream.
auto	write_line (uint32 value) -> void
	Writes the specified uint32 value and new line to the text stream.
auto	write_line (uint64 value) -> void
	Writes the specified uint64 value and new line to the text stream.
template<class value_t>
auto	write_line (value_t value) -> void
	Writes the specified value_t value and new line to the text stream.
template<class ... args_t>
auto	write_line (const xtd::string &fmt, args_t &&... args) noexcept -> void
	Writes the specified arguments with specified format to the text stream.
	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 xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
static auto	null () noexcept -> null_text_writer &
	Provides a text_writer with no backing store that can be written to, but not read from.
static auto	synchronised (text_writer &writer) noexcept -> synchronized_text_writer
	Creates a thread-safe (synchronized) wrapper around the specified text_writer object.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
	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::string & str )

explicit

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

Parameters

str	base string.

Member Function Documentation

base_stream() [1/2]

auto xtd::io::string_writer::base_stream ( ) const -> const std::ostream &

nodiscardnoexcept

Returns the underlying stream.

Returns

The underlying stream.

base_stream() [2/2]

auto xtd::io::string_writer::base_stream ( ) -> std::ostream &

nodiscardnoexcept

Returns the underlying stream.

Returns

The underlying stream.

flush()

auto xtd::io::string_writer::flush ( ) -> void

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()

auto xtd::io::string_writer::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

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

Returns

A string that represents the current object.

Examples

The following code example demonstrates what to_string returns.

#include <xtd/xtd>
 
namespace examples {
  namespace object_test {
    class object1 : public object {
    };
  }
}
 
auto main() -> int {
  ptr<object> obj1 = new_ptr<examples::object_test::object1>();
  console::write_line(obj1->to_string());
 
  ptr<object> obj2 = new_ptr<date_time>(1971, 1, 5, 23, 5, 0);
  console::write_line(obj2->to_string());
 
  ptr<object> obj3 = new_ptr<boolean_object>();
  console::write_line(obj3->to_string());
}
 
// This code produces the following output :
//
// examples::object_test::object1
// Tue Jan  5 23:05:00 1971
// false

Reimplemented from xtd::object.

write()

auto xtd::io::string_writer::write ( const xtd::string & value ) -> void

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.

---

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

• xtd.core/include/xtd/io/string_writer.hpp