Inherits System::IO::TextWriter.

Public Member Functions
ASPOSECPP_SHARED_API	StreamWriter (const SharedPtr< Stream > &stream)

ASPOSECPP_SHARED_API	StreamWriter (const SharedPtr< Stream > &stream, const EncodingPtr &encoding)

ASPOSECPP_SHARED_API	StreamWriter (const SharedPtr< Stream > &stream, const EncodingPtr &encoding, int buffer_size, bool leave_open=false)

ASPOSECPP_SHARED_API	StreamWriter (const String &path)

ASPOSECPP_SHARED_API	StreamWriter (const String &path, bool append, const EncodingPtr &encoding=System::Text::Encoding::get_UTF8Unmarked())

ASPOSECPP_SHARED_API	StreamWriter (const String &path, bool append, const EncodingPtr &encoding, int buffer_size)

ASPOSECPP_SHARED_API	~StreamWriter ()
	Destructor. More...

ASPOSECPP_SHARED_API bool	get_AutoFlush () const

ASPOSECPP_SHARED_API void	set_AutoFlush (bool value)

ASPOSECPP_SHARED_API SharedPtr< Stream >	get_BaseStream () const
	Returns a shared pointer to an object that represents the underlying stream. More...

ASPOSECPP_SHARED_API EncodingPtr	get_Encoding () override
	Returns the currently used encoding. More...

ASPOSECPP_SHARED_API void	Write (char_t value) override

ASPOSECPP_SHARED_API void	Write (const String &value) override

ASPOSECPP_SHARED_API void	Write (const SharedPtr< Object > &obj) override

ASPOSECPP_SHARED_API void	Write (const ArrayPtr< char_t > &buffer) override

ASPOSECPP_SHARED_API void	Write (const ArrayPtr< char_t > &buffer, int32_t index, int32_t count) override

ASPOSECPP_SHARED_API void	Write (const char_t *buffer) override

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

ASPOSECPP_SHARED_API void	WriteLine (const String &value) override

ASPOSECPP_SHARED_API void	WriteLine (const SharedPtr< Object > &obj) override

ASPOSECPP_SHARED_API void	WriteLine (const ArrayPtr< char_t > &buffer) override

ASPOSECPP_SHARED_API void	WriteLine (const ArrayPtr< char_t > &buffer, int32_t index, int32_t count) override

ASPOSECPP_SHARED_API void	WriteLine (const char_t *buffer) override

template<typename T >
void	Write (const System::SharedPtr< T > &obj)

template<typename T >
void	WriteLine (const System::SharedPtr< T > &obj)

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

ASPOSECPP_SHARED_API void	Flush () override

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

Public Member Functions inherited from System::IO::TextWriter
virtual ASPOSECPP_SHARED_API SharedPtr< IFormatProvider >	get_FormatProvider () const
	Returns the currently used IFormatProvider object. More...

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

virtual ASPOSECPP_SHARED_API void	set_NewLine (const System::String &value)

virtual	~TextWriter ()
	Destructor. More...

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

ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API void	Write (bool value)

virtual ASPOSECPP_SHARED_API void	Write (Decimal value)

virtual ASPOSECPP_SHARED_API void	Write (double value)

virtual ASPOSECPP_SHARED_API void	Write (int value)

virtual ASPOSECPP_SHARED_API void	Write (int64_t value)

virtual ASPOSECPP_SHARED_API void	Write (float value)

virtual ASPOSECPP_SHARED_API void	Write (uint32_t value)

virtual ASPOSECPP_SHARED_API void	Write (uint64_t value)

virtual ASPOSECPP_SHARED_API void	WriteLine (bool value)

virtual ASPOSECPP_SHARED_API void	WriteLine (char_t value)

virtual ASPOSECPP_SHARED_API void	WriteLine (Decimal value)

virtual ASPOSECPP_SHARED_API void	WriteLine (double value)

virtual ASPOSECPP_SHARED_API void	WriteLine (int value)

virtual ASPOSECPP_SHARED_API void	WriteLine (int64_t value)

virtual ASPOSECPP_SHARED_API void	WriteLine (float value)

virtual ASPOSECPP_SHARED_API void	WriteLine (uint32_t value)

virtual ASPOSECPP_SHARED_API void	WriteLine (uint64_t value)

virtual ASPOSECPP_SHARED_API void	Write (const TypeInfo &value)

virtual ASPOSECPP_SHARED_API void	WriteLine (const TypeInfo &value)

template<class... TArgs>
void	Write (const String &format, const TArgs &... args)

template<class... TArgs>
void	WriteLine (const String &format, const TArgs &... args)

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

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

ASPOSECPP_SHARED_API	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...

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

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

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

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

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

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

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

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

virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Additional Inherited Members
Public Types inherited from System::IO::TextWriter
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...

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...

Detailed Description

Represents a writer that writes characters to a byte stream. 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.

Constructor & Destructor Documentation

◆ StreamWriter() [1/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const SharedPtr< Stream > & stream )

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using UTF-8 encoding and a buffer with default size of 1024 bytes.

Parameters

stream The underlying stream to write characters to

◆ StreamWriter() [2/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter	(	const SharedPtr< Stream > &	stream,
		const EncodingPtr &	encoding
	)

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer with default size of 1024 bytes.

Parameters

stream	The underlying stream to write characters to
encoding	The encoding to use

◆ StreamWriter() [3/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter	(	const SharedPtr< Stream > &	stream,
		const EncodingPtr &	encoding,
		int	buffer_size,
		bool	leave_open = `false`
	)

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer of the specified size. A parameter specifies whether the underlying stream should be closed when the StreamWriter object is disposed.

Parameters

stream	The underlying stream to write characters to
encoding	The encoding to use
buffer_size	The minimum size of the buffer in bytes
leave_open	Specifies whether the underlying stream should be left open after the current StreamWriter object is disposed

◆ StreamWriter() [4/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const String & path )

Constructs an instance of StreamWriter object that writes characters to the specified file using UTF-8 encoding and a buffer with default size of 1024 bytes.

Parameters

path	The path of the file to write characters to

◆ StreamWriter() [5/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter	(	const String &	path,
		bool	append,
		const EncodingPtr &	encoding = `System::Text::Encoding::get_UTF8Unmarked()`
	)

Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and a buffer with default size of 1024 bytes. A parameter specifies whether the data should be appened to the file or the file should be overwritten.

Parameters

path	The path of the file to write characters to
append	Specifies whether the data should be appended to the specified file (true) or the file should be overwritten (false)
encoding	The encoding to use

◆ StreamWriter() [6/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter	(	const String &	path,
		bool	append,
		const EncodingPtr &	encoding,
		int	buffer_size
	)

Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and buffer size. A parameter specifies whether the data should be appened to the file or the file should be overwritten.

Parameters

path	The path of the file to write characters to
append	Specifies whether the data should be appended to the specified file (true) or the file should be overwritten (false)
encoding	The encoding to use
buffer_size	The size of buffer to use

◆ ~StreamWriter()

ASPOSECPP_SHARED_API System::IO::StreamWriter::~StreamWriter ( )

Destructor.

Member Function Documentation

◆ Close()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Close ( )

overridevirtual

Closes the stream and releases aquired resources.

Reimplemented from System::IO::TextWriter.

◆ Dispose()

virtual void System::IO::TextWriter::Dispose

inlineoverride

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

◆ Flush()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Flush ( )

overridevirtual

Flushes the content of the buffer to the underlying stream and then flushes the underlying stream.

Reimplemented from System::IO::TextWriter.

◆ get_AutoFlush()

ASPOSECPP_SHARED_API bool System::IO::StreamWriter::get_AutoFlush ( ) const

Returns a value that indicates whether the StreamWriter will flush the data to the underlying stream every time method StreamWriter::Write is called.

◆ get_BaseStream()

ASPOSECPP_SHARED_API SharedPtr<Stream> System::IO::StreamWriter::get_BaseStream ( ) const

Returns a shared pointer to an object that represents the underlying stream.

◆ get_Encoding()

ASPOSECPP_SHARED_API EncodingPtr System::IO::StreamWriter::get_Encoding ( )

overridevirtual

Returns the currently used encoding.

Implements System::IO::TextWriter.

◆ set_AutoFlush()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::set_AutoFlush ( bool value )

Returns a value that specifies whether the StreamWriter should flush the data to the underlying stream every time method StreamWriter::Write is called.

◆ Write() [1/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( char_t value )

overridevirtual

Writes the specified character to the stream.

Parameters

value The character to write

Reimplemented from System::IO::TextWriter.

◆ Write() [2/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( const String & value )

overridevirtual

Writes the specified string to the stream.

Parameters

value The string to write

Reimplemented from System::IO::TextWriter.

◆ Write() [3/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( const SharedPtr< Object > & obj )

overridevirtual

Writes the string representation of the specified object to the stream.

Parameters

obj	The object to write

Reimplemented from System::IO::TextWriter.

◆ Write() [4/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( const ArrayPtr< char_t > & buffer )

overridevirtual

Writes all characetrs from the specified array to the stream.

Parameters

buffer The array containing the characters to write

Reimplemented from System::IO::TextWriter.

◆ Write() [5/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write	(	const ArrayPtr< char_t > &	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Writes the specified subrange of UTF-16 characters from the specified character array to the stream.

Parameters

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

Reimplemented from System::IO::TextWriter.

◆ Write() [6/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( const char_t * buffer )

overridevirtual

Writes the specified c-string to the stream.

Parameters

buffer The c-string to write

Reimplemented from System::IO::TextWriter.

◆ Write() [7/7]

template<typename T >

void System::IO::StreamWriter::Write ( const System::SharedPtr< T > & obj )

inline

Writes the string representation of the specified object to the stream.

Parameters

obj	The object to write

Template Parameters

T	The type of the object

◆ WriteLine() [1/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( )

overridevirtual

Writes line terminator characters to the stream.

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [2/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( const String & value )

overridevirtual

Writes the specified string followed by the line-terminating characters to the stream.

Parameters

value The string to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [3/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( const SharedPtr< Object > & obj )

overridevirtual

Writes the string representation of the specified object followed by the line-terminating characters to the stream.

Parameters

obj	The object to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [4/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( const ArrayPtr< char_t > & buffer )

overridevirtual

Writes all characetrs from the specified array followed by the line-terminating characters to the stream.

Parameters

buffer The array containing the characters to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [5/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine	(	const ArrayPtr< char_t > &	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters to the stream.

Parameters

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

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [6/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( const char_t * buffer )

inlineoverridevirtual

Writes the specified c-string followed by the line-terminating characters to the stream.

Parameters

buffer The c-string to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [7/7]

template<typename T >

void System::IO::StreamWriter::WriteLine ( const System::SharedPtr< T > & obj )

inline

Writes the string representation of the specified object followed by the line-terminating characters to the stream.

Parameters

obj	The object to write

Template Parameters

T	The type of the object

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StreamWriter() [1/6]

◆ StreamWriter() [2/6]

◆ StreamWriter() [3/6]

◆ StreamWriter() [4/6]

◆ StreamWriter() [5/6]

◆ StreamWriter() [6/6]

◆ ~StreamWriter()

Member Function Documentation

◆ Close()

◆ Dispose()

◆ Flush()

◆ get_AutoFlush()

◆ get_BaseStream()

◆ get_Encoding()

◆ set_AutoFlush()

◆ Write() [1/7]

◆ Write() [2/7]

◆ Write() [3/7]

◆ Write() [4/7]

◆ Write() [5/7]

◆ Write() [6/7]

◆ Write() [7/7]

◆ WriteLine() [1/7]

◆ WriteLine() [2/7]

◆ WriteLine() [3/7]

◆ WriteLine() [4/7]

◆ WriteLine() [5/7]

◆ WriteLine() [6/7]

◆ WriteLine() [7/7]