Represents a writer that writes values of primitive types 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. More...

#include <binary_writer.h>

Inherits System::IDisposable.

Public Member Functions
	BinaryWriter (const StreamPtr &stream, const EncodingPtr &encoding=System::Text::Encoding::get_UTF8Unmarked(), bool leaveopen=false)
	Constructs an instance of BinaryWriter class that writes data to the specified stream using the specified encoding. More...

	~BinaryWriter ()
	Destructor. More...

StreamPtr	get_BaseStream ()
	Returns the output stream. More...

void	Flush ()
	Flushes the output stream. More...

void	Close ()
	Closes the current BinaryWriter object and the underlying output stream. More...

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

int64_t	Seek (int offset, System::IO::SeekOrigin origin=System::IO::SeekOrigin::Begin)
	Sets the position of the stream represented by the current object. More...

virtual void	Write (uint8_t value)
	Writes the specified unsigned 8-bit integer value to the output stream. More...

virtual void	Write (const ArrayPtr< uint8_t > &buffer, int index=0, int count=-1)
	Writes the specified subrange of bytes from the specified byte array to the output stream. More...

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

virtual void	Write (bool value)
	Writes single byte with a value of 0 if `value` is 'true' and 1 if `value` is 'false' to the output stream. More...

virtual void	Write (char16_t value)
	Writes the specified 16-bit wide character value to the output stream. More...

virtual void	Write (int16_t value)
	Writes the specified 16-bit integer value to the output stream. More...

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

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

virtual void	Write (uint16_t value)
	Writes the specified unsigned 16-bit integer value to the output stream. More...

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

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

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

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

virtual void	Write (const Decimal &value)
	Writes the byte representation of the specified Decimal value to the output stream. More...

virtual void	Write (const String &value)
	Writes a length-prefixed string in the current encoding to the output stream. More...

virtual void	Write (const char_t *value)
	Writes a length-prefixed string in the current encoding to the output 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
void	Dispose (bool disposing)
	Releases all resources used by the current object and closes the undelying stream. More...

void	Write7BitEncodedInt (int value)
	Writes int value byte by byte. More...

Additional Inherited Members
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...

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

Represents a writer that writes values of primitive types 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

◆ BinaryWriter()

System::IO::BinaryWriter::BinaryWriter	(	const StreamPtr &	stream,
		const EncodingPtr &	encoding = `System::Text::Encoding::get_UTF8Unmarked()`,
		bool	leaveopen = `false`
	)

Constructs an instance of BinaryWriter class that writes data to the specified stream using the specified encoding.

Parameters

stream	The output stream
encoding	The encoding to use
leaveopen	Specifies whether the stream `stream` should be left open (true) after the current object has been disposed or not (false)

◆ ~BinaryWriter()

System::IO::BinaryWriter::~BinaryWriter ( )

Destructor.

Member Function Documentation

◆ Close()

void System::IO::BinaryWriter::Close ( )

Closes the current BinaryWriter object and the underlying output stream.

◆ Dispose() [1/2]

void System::IO::BinaryWriter::Dispose ( )

overridevirtual

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

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

void System::IO::BinaryWriter::Dispose ( bool disposing )

protected

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

Parameters

disposing Specifies whether the undelying stream should be closed.

◆ Flush()

void System::IO::BinaryWriter::Flush ( )

Flushes the output stream.

◆ get_BaseStream()

StreamPtr System::IO::BinaryWriter::get_BaseStream ( )

Returns the output stream.

◆ Seek()

int64_t System::IO::BinaryWriter::Seek	(	int	offset,
		System::IO::SeekOrigin	origin = `System::IO::SeekOrigin::Begin`
	)

Sets the position of the stream represented by the current object.

Parameters

offset	The byte offset relative to a position specified by `origin`
origin	Specifies the position from which and the direction toward which the offset is calculated

Returns: The new position of the stream

◆ Write() [1/16]

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

virtual

Writes single byte with a value of 0 if value is 'true' and 1 if value is 'false' to the output stream.

Parameters

value The boolean value specifying the byte value to write to the output stream

◆ Write() [2/16]

virtual void System::IO::BinaryWriter::Write ( char16_t value )

virtual

Writes the specified 16-bit wide character value to the output stream.

Parameters

value The value to write

◆ Write() [3/16]

virtual void System::IO::BinaryWriter::Write	(	const ArrayPtr< char_t > &	buffer,
		int	index = `0`,
		int	count = `-1`
	)

virtual

Writes the specified subrange of UTF-16 characters from the specified character array to the output 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

◆ Write() [4/16]

virtual void System::IO::BinaryWriter::Write	(	const ArrayPtr< uint8_t > &	buffer,
		int	index = `0`,
		int	count = `-1`
	)

virtual

Writes the specified subrange of bytes from the specified byte array to the output stream.

Parameters

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

◆ Write() [5/16]

virtual void System::IO::BinaryWriter::Write ( const char_t * value )

virtual

Writes a length-prefixed string in the current encoding to the output stream.

Parameters

value The c-string to write

◆ Write() [6/16]

virtual void System::IO::BinaryWriter::Write ( const Decimal & value )

virtual

Writes the byte representation of the specified Decimal value to the output stream.

Parameters

value The value to write

◆ Write() [7/16]

virtual void System::IO::BinaryWriter::Write ( const String & value )

virtual

Writes a length-prefixed string in the current encoding to the output stream.

Parameters

value The string to write

◆ Write() [8/16]

virtual void System::IO::BinaryWriter::Write ( double value )

virtual

Writes the specified double-precision floating point value to the output stream.

Parameters

value The value to write

◆ Write() [9/16]

virtual void System::IO::BinaryWriter::Write ( float value )

virtual

Writes the specified single-precision floating point value to the output stream.

Parameters

value The value to write

◆ Write() [10/16]

virtual void System::IO::BinaryWriter::Write ( int value )

virtual

Writes the specified 32-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [11/16]

virtual void System::IO::BinaryWriter::Write ( int16_t value )

virtual

Writes the specified 16-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [12/16]

virtual void System::IO::BinaryWriter::Write ( int64_t value )

virtual

Writes the specified 64-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [13/16]

virtual void System::IO::BinaryWriter::Write ( uint16_t value )

virtual

Writes the specified unsigned 16-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [14/16]

virtual void System::IO::BinaryWriter::Write ( uint32_t value )

virtual

Writes the specified unsigned 32-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [15/16]

virtual void System::IO::BinaryWriter::Write ( uint64_t value )

virtual

Writes the specified unsigned 64-bit integer value to the output stream.

Parameters

value The value to write

◆ Write() [16/16]

virtual void System::IO::BinaryWriter::Write ( uint8_t value )

virtual

Writes the specified unsigned 8-bit integer value to the output stream.

Parameters

value The value to write

◆ Write7BitEncodedInt()

void System::IO::BinaryWriter::Write7BitEncodedInt ( int value )

protected

Writes int value byte by byte.

Parameters

value The value to write

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinaryWriter()

◆ ~BinaryWriter()

Member Function Documentation

◆ Close()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ Flush()

◆ get_BaseStream()

◆ Seek()

◆ 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]

◆ Write7BitEncodedInt()