xtd::io::text_writer Class Reference

Inheritance diagram for xtd::io::text_writer:

Definition

Represents a writer that can write a sequential series of characters.

class core_export_ text_writer : public xtd::object

Inheritance

xtd::object → xtd::io::text_writer

Header

#include <xtd/io/text_writer>

Namespace

xtd::io

Library

xtd.core

Public Fields
static null_text_writer &	null () noexcept
	Provides a text_writer with no backing store that can be written to, but not read from.

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

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

Public Methods
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.
virtual void	write (const xtd::string &value)
	Writes the specified string value to the text stream.
void	write (bool value)
	Writes the specified bool 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 (sbyte value)
	Writes the specified sbyte value to the text stream.
void	write (int16 value)
	Writes the specified int16 value to the text stream.
void	write (int32 value)
	Writes the specified int32 value to the text stream.
void	write (int64 value)
	Writes the specified int64 value to the text stream.
void	write (xtd::byte value)
	Writes the specified xtd::byte value to the text stream.
void	write (uint16 value)
	Writes the specified uint16 value to the text stream.
void	write (uint32 value)
	Writes the specified uint32 value to the text stream.
void	write (uint64 value)
	Writes the specified uint64 value to the text stream.
template<typename value_t >
void	write (value_t value)
	Writes the specified value_t value to the text stream.
template<typename ... args_t>
void	write (const xtd::string &fmt, args_t &&... args) noexcept
	Writes the specified arguments with specified format to the text stream.
void	write_line ()
	Writes new line to the text stream.
void	write_line (const xtd::string &value)
	Writes the specified string value and new line to the text stream.
void	write_line (bool value)
	Writes the specified bool 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 (sbyte value)
	Writes the specified sbyte value and new line to the text stream.
void	write_line (int16 value)
	Writes the specified int16 value and new line to the text stream.
void	write_line (int32 value)
	Writes the specified int32 value and new line to the text stream.
void	write_line (int64 value)
	Writes the specified int64 value and new line to the text stream.
void	write_line (xtd::byte value)
	Writes the specified xtd::byte value and new line to the text stream.
void	write_line (uint16 value)
	Writes the specified uint16 value and new line to the text stream.
void	write_line (uint32 value)
	Writes the specified uint32 value and new line to the text stream.
void	write_line (uint64 value)
	Writes the specified uint64 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.
template<typename ... args_t>
void	write_line (const xtd::string &fmt, args_t &&... args) noexcept
	Writes the specified arguments with specified format to the text stream.

Protected constructors
	text_writer ()=default
	Initializes a new instance of the xtd::io::text_writer class.

Additional Inherited Members
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.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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.

Constructor & Destructor Documentation

text_writer()

xtd::io::text_writer::text_writer ( )

protecteddefault

Initializes a new instance of the xtd::io::text_writer class.

Member Function Documentation

null()

static null_text_writer & xtd::io::text_writer::null ( )

staticnoexcept

Provides a text_writer with no backing store that can be written to, but not read from.

Remarks

Use null to redirect output to a stream that will not consume any operating system resources.

When the text_writer::write methods are invoked on null, the call simply returns, and no data is actually written to any backing store.

new_line() [1/2]

const xtd::string & xtd::io::text_writer::new_line ( ) const

noexcept

Gets the line terminator string used by the current text_writer.

new_line() [2/2]

void xtd::io::text_writer::new_line ( const xtd::string &  new_line )

noexcept

Sets the line terminator string used by the current text_writer.

close()

virtual void xtd::io::text_writer::close ( )

virtual

Closes the xtd::io::text_reader and releases any system resources associated with the text_reader.

Reimplemented in xtd::io::stream_writer.

flush()

virtual void xtd::io::text_writer::flush ( )

virtual

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 in xtd::io::stream_writer, and xtd::io::string_writer.

write() [1/14]

virtual void xtd::io::text_writer::write ( const xtd::string &  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 in xtd::io::null_text_writer, xtd::io::stream_writer, xtd::io::stream_writer, xtd::io::string_writer, and xtd::io::synchronized_text_writer.

write() [2/14]

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() [3/14]

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() [4/14]

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() [5/14]

void xtd::io::text_writer::write

(

sbyte

value

)

Writes the specified sbyte value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [6/14]

void xtd::io::text_writer::write

(

int16

value

)

Writes the specified int16 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [7/14]

void xtd::io::text_writer::write

(

int32

value

)

Writes the specified int32 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [8/14]

void xtd::io::text_writer::write

(

int64

value

)

Writes the specified int64 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [9/14]

void xtd::io::text_writer::write

(

xtd::byte

value

)

Writes the specified xtd::byte value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [10/14]

void xtd::io::text_writer::write

(

uint16

value

)

Writes the specified uint16 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [11/14]

void xtd::io::text_writer::write

(

uint32

value

)

Writes the specified uint32 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [12/14]

void xtd::io::text_writer::write

(

uint64

value

)

Writes the specified uint64 value to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write() [13/14]

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.

write() [14/14]

template<typename ... args_t>

void xtd::io::text_writer::write ( const xtd::string &  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_line() [1/15]

void xtd::io::text_writer::write_line

(

)

Writes new line to the text stream.

Exceptions

io::io_exception

An I/O error occurs.

Examples

file_info_open.cpp, file_info_open_read.cpp, and file_info_open_write.cpp.

write_line() [2/15]

void xtd::io::text_writer::write_line

(

const xtd::string &

value

)

Writes the specified string value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [3/15]

void xtd::io::text_writer::write_line

(

bool

value

)

Writes the specified bool value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [4/15]

void xtd::io::text_writer::write_line

(

double

value

)

Writes the specified double value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [5/15]

void xtd::io::text_writer::write_line

(

float

value

)

Writes the specified float value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [6/15]

void xtd::io::text_writer::write_line

(

sbyte

value

)

Writes the specified sbyte value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [7/15]

void xtd::io::text_writer::write_line

(

int16

value

)

Writes the specified int16 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [8/15]

void xtd::io::text_writer::write_line

(

int32

value

)

Writes the specified int32 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [9/15]

void xtd::io::text_writer::write_line

(

int64

value

)

Writes the specified int64 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [10/15]

void xtd::io::text_writer::write_line

(

xtd::byte

value

)

Writes the specified xtd::byte value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [11/15]

void xtd::io::text_writer::write_line

(

uint16

value

)

Writes the specified uint16 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [12/15]

void xtd::io::text_writer::write_line

(

uint32

value

)

Writes the specified uint32 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [13/15]

void xtd::io::text_writer::write_line

(

uint64

value

)

Writes the specified uint64 value and new line to the text stream.

Parameters

value

The value to write.

Exceptions

io::io_exception

An I/O error occurs.

write_line() [14/15]

template<typename value_t >

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

inline

Writes the specified value_t value and new line 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.

write_line() [15/15]

template<typename ... args_t>

void xtd::io::text_writer::write_line ( const xtd::string &  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.

synchronised()

static synchronized_text_writer xtd::io::text_writer::synchronised ( text_writer &  writer )

staticnoexcept

Creates a thread-safe (synchronized) wrapper around the specified text_writer object.

Parameters

reader

The TextReader object to synchronize.

Returns

text_writer A thread-safe text_writer object.

---

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

• xtd.core/include/xtd/io/text_writer.h