A base class for classes that represent writers that writes sequences of characters to different destinations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <text_writer.h>

Inherits System::IDisposable.

Inherited by System::ConsoleOutput, System::IO::StreamWriter, and System::IO::StringWriter.

Public Types
typedef System::SharedPtr< TextWriter >	Ptr
	An alias for a shared pointer to this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
virtual SharedPtr< System::Text::Encoding >	get_Encoding ()=0
	Returns the currently used encoding. More...

virtual SharedPtr< IFormatProvider >	get_FormatProvider () const
	Returns the currently used IFormatProvider object. More...

virtual System::String	get_NewLine () const
	Returns a line terminator string. More...

virtual void	set_NewLine (const System::String &value)
	Sets a line terminator string. More...

virtual	~TextWriter ()
	Destructor. More...

String	get_NewLine ()
	Returns a line terminator string. More...

IFormatProviderPtr	get_FormatProvider ()
	Returns the currently used IFormatProvider object. More...

virtual void	Dispose () override
	Releases all resources used by the current object and closes the undelying stream. More...

virtual void	Close ()
	Closes the stream and releases aquired resources. More...

virtual void	Flush ()
	Flushes the content of the buffer to the underlying stream. More...

virtual void	Write (const SharedPtr< Object > &value)
	Writes the string representation of the specified object to the stream. More...

virtual void	Write (bool value)
	Writes the string representation of the specified boolean value to the stream. More...

virtual void	Write (char_t value)
	Writes the specified character to the stream. More...

virtual void	Write (Decimal value)
	Writes the string representation of the specified Decimal object to the stream. More...

virtual void	Write (double value)
	Writes the string representation of the specified double-precision floating point value to the stream. More...

virtual void	Write (int value)
	Writes the string representation of the specified 32-bit integer value to the stream. More...

virtual void	Write (int64_t value)
	Writes the string representation of the specified 64-bit integer value to the stream. More...

virtual void	Write (float value)
	Writes the string representation of the specified single-precision floating point value to the stream. More...

virtual void	Write (const String &value)
	Writes the specified string to the stream. More...

virtual void	Write (uint32_t value)
	Writes the string representation of the specified unsigned 32-bit integer value to the stream. More...

virtual void	Write (uint64_t value)
	Writes the string representation of the specified unsigned 64-bit integer value to the stream. More...

virtual void	Write (const ArrayPtr< char_t > &buffer)
	Writes all characetrs from the specified array to the stream. More...

virtual void	Write (const ArrayPtr< char_t > &buffer, int32_t index, int32_t count)
	Writes the specified subrange of UTF-16 characters from the specified character array to the stream. More...

virtual void	WriteLine ()
	Writes line terminator characters to the stream. More...

virtual void	WriteLine (const SharedPtr< Object > &value)
	Writes the string representation of the specified object followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (bool value)
	Writes the string representation of the specified boolean value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (char_t value)
	Writes the specified character followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (Decimal value)
	Writes the string representation of the specified Decimal object followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (double value)
	Writes the string representation of the specified double-precision floating point value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (int value)
	Writes the string representation of the specified 32-bit integer value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (int64_t value)
	Writes the string representation of the specified 64-bit integer value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (float value)
	Writes the string representation of the specified single-precision floating point value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (const String &value)
	Writes the specified string followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (uint32_t value)
	Writes the string representation of the specified unsigned 32-bit integer value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (uint64_t value)
	Writes the string representation of the specified unsigned 64-bit integer value followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (const ArrayPtr< char_t > &buffer)
	Writes all characetrs from the specified array followed by the line-terminating characters to the stream. More...

virtual void	WriteLine (const ArrayPtr< char_t > &buffer, int32_t index, int32_t count)
	Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters to the stream. More...

virtual void	Write (const char_t *value)
	Writes the specified c-string to the stream. More...

virtual void	WriteLine (const char_t *value)
	Writes the specified c-string followed by the line-terminating characters to the stream. More...

virtual void	Write (const TypeInfo &value)
	Writes the string representation of the specified TypeInfo object to the stream. More...

virtual void	WriteLine (const TypeInfo &value)
	Writes the string representation of the specified TypeInfo object followed by the line-terminating characters to the stream. More...

template<class... TArgs>
void	Write (const String &format, const TArgs &... args)
	Writes the specified values formatted according to the specified format to the stream. More...

template<class... TArgs>
void	WriteLine (const String &format, const TArgs &... args)
	Writes the specified values formatted according to the specified format followed by the line-terminating characetrs to the stream. More...

virtual void	Dispose ()
	Does nothing. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
virtual void	WriteImpl (const char_t *value, int32_t length)
	Writes the specified c-string to the stream. More...

virtual void	Dispose (bool disposing)
	Releases all resources used by the current object and closes the undelying stream. More...

	TextWriter ()
	Constructs a new intstance of TextWriter class that uses IFormatProvider object from the invariant culture. More...

	TextWriter (const IFormatProviderPtr &formatProvider)
	Constructs a new intstance of TextWriter class that uses the specified IFormatProvider object. More...

Protected Attributes
ArrayPtr< char_t >	CoreNewLine
	The line terminator string. More...

IFormatProviderPtr	internalFormatProvider
	IFormatProvider used by the current object. More...

Additional Inherited Members
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

A base class for classes that represent writers that writes sequences of characters to different destinations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

typedef System::SharedPtr<TextWriter> System::IO::TextWriter::Ptr

An alias for a shared pointer to this class.

Constructor & Destructor Documentation

◆ ~TextWriter()

virtual System::IO::TextWriter::~TextWriter ( )

inlinevirtual

Destructor.

◆ TextWriter() [1/2]

System::IO::TextWriter::TextWriter ( )

protected

Constructs a new intstance of TextWriter class that uses IFormatProvider object from the invariant culture.

◆ TextWriter() [2/2]

System::IO::TextWriter::TextWriter ( const IFormatProviderPtr & formatProvider )

protected

Constructs a new intstance of TextWriter class that uses the specified IFormatProvider object.

Parameters

formatProvider The format provider object to use

Member Function Documentation

◆ Close()

virtual void System::IO::TextWriter::Close ( )

inlinevirtual

Closes the stream and releases aquired resources.

Reimplemented in System::IO::StreamWriter.

◆ Dispose() [1/2]

virtual void System::IO::TextWriter::Dispose ( )

inlineoverridevirtual

Releases all resources used by the current object and closes the undelying stream.

Reimplemented from System::IDisposable.

Reimplemented in System::IO::StreamWriter.

◆ Dispose() [2/2]

virtual void System::IO::TextWriter::Dispose ( bool disposing )

protectedvirtual

Releases all resources used by the current object and closes the undelying stream.

Parameters

disposing Specifies whether the undelying stream should be closed.

Reimplemented in System::IO::StreamWriter, and System::IO::StreamWriter.

◆ Flush()

virtual void System::IO::TextWriter::Flush ( )

inlinevirtual

Flushes the content of the buffer to the underlying stream.

Reimplemented in System::IO::StreamWriter.

◆ get_Encoding()

virtual SharedPtr< System::Text::Encoding > System::IO::TextWriter::get_Encoding ( )

pure virtual

Returns the currently used encoding.

Implemented in System::ConsoleOutput, System::IO::StreamWriter, and System::IO::StringWriter.

◆ get_FormatProvider() [1/2]

IFormatProviderPtr System::IO::TextWriter::get_FormatProvider ( )

Returns the currently used IFormatProvider object.

◆ get_FormatProvider() [2/2]

virtual SharedPtr< IFormatProvider > System::IO::TextWriter::get_FormatProvider ( ) const

virtual

Returns the currently used IFormatProvider object.

◆ get_NewLine() [1/2]

String System::IO::TextWriter::get_NewLine ( )

Returns a line terminator string.

◆ get_NewLine() [2/2]

virtual System::String System::IO::TextWriter::get_NewLine ( ) const

virtual

Returns a line terminator string.

◆ set_NewLine()

virtual void System::IO::TextWriter::set_NewLine ( const System::String & value )

virtual

Sets a line terminator string.

Parameters

value A value to set

◆ Write() [1/16]

virtual void System::IO::TextWriter::Write ( bool value )

virtual

Writes the string representation of the specified boolean value to the stream.

Parameters

value The value to write

buffer	The array containing the characters to write
index	A 0-based index of the elemnet in `buffer` at which the subrange to write begins
count	The number of characters in the subrange to write; -1 specifies that the subrange ends where `buffer` array ends

value	The c-string to write
length	Maximum length of the string

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~TextWriter()

◆ TextWriter() [1/2]

◆ TextWriter() [2/2]

Member Function Documentation

◆ Close()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ Flush()

◆ get_Encoding()

◆ get_FormatProvider() [1/2]

◆ get_FormatProvider() [2/2]

◆ get_NewLine() [1/2]

◆ get_NewLine() [2/2]

◆ set_NewLine()

◆ Write() [1/16]

◆ Write() [2/16]

◆ Write() [3/16]

◆ Write() [4/16]

◆ Write() [5/16]

◆ Write() [6/16]

◆ Write() [7/16]

◆ Write() [8/16]

◆ Write() [9/16]

◆ Write() [10/16]

◆ Write() [11/16]

◆ Write() [12/16]

◆ Write() [13/16]

◆ Write() [14/16]

◆ Write() [15/16]

◆ Write() [16/16]

◆ WriteImpl()

◆ WriteLine() [1/17]

◆ WriteLine() [2/17]

◆ WriteLine() [3/17]

◆ WriteLine() [4/17]

◆ WriteLine() [5/17]

◆ WriteLine() [6/17]

◆ WriteLine() [7/17]

◆ WriteLine() [8/17]

◆ WriteLine() [9/17]

◆ WriteLine() [10/17]

◆ WriteLine() [11/17]

◆ WriteLine() [12/17]

◆ WriteLine() [13/17]

◆ WriteLine() [14/17]

◆ WriteLine() [15/17]

◆ WriteLine() [16/17]

◆ WriteLine() [17/17]

Member Data Documentation

◆ CoreNewLine

◆ internalFormatProvider