CodePorting.Translator Cs2Cpp
CodePorting.Translator.Cs2Cpp.Framework
System::Buffers::ArrayBufferWriter< T > Class Template Referencefinal

Represents a heap-based, array-backed output sink into which data can be written. More...

#include <array_buffer_writer.h>

Inherits System::Buffers::IBufferWriter< T >.

Public Member Functions

 ArrayBufferWriter ()
 Creates an instance of an ArrayBufferWriter, in which data can be written to, with the default initial capacity. More...
 
 ArrayBufferWriter (int32_t initialCapacity)
 Creates an instance of an ArrayBufferWriter, in which data can be written to, with an initial capacity specified. More...
 
ReadOnlyMemory< T > get_WrittenMemory () const
 Returns the data written to the underlying buffer so far, as a ReadOnlyMemory. More...
 
ReadOnlySpan< T > get_WrittenSpan () const
 Returns the data written to the underlying buffer so far, as a ReadOnlySpan. More...
 
int32_t get_WrittenCount () const
 Returns the amount of data written to the underlying buffer so far. More...
 
int32_t get_Capacity () const
 Returns the total amount of space within the underlying buffer. More...
 
int32_t get_FreeCapacity () const
 Returns the amount of space available that can still be written into without forcing the underlying buffer to grow. More...
 
void Clear ()
 Clears the data written to the underlying buffer. More...
 
void ResetWrittenCount ()
 Resets the data written to the underlying buffer without zeroing its content. More...
 
void Advance (int32_t count) override
 Notifies the writer that count amount of data was written to the output Span/Memory. More...
 
Memory< T > GetMemory (int32_t sizeHint=0) override
 Returns a Memory to write to that is at least the requested length (specified by sizeHint). If no sizeHint is provided (or it's equal to 0), some non-empty buffer is returned. More...
 
Span< T > GetSpan (int32_t sizeHint=0) override
 Returns a Span to write to that is at least the requested length (specified by sizeHint). If no sizeHint is provided (or it's equal to 0), some non-empty buffer is returned. More...
 
virtual void Advance (int32_t count)=0
 Notifies the IBufferWriter implementation that count elements were written to the output. More...
 
virtual System::Memory< T > GetMemory (int32_t sizeHint=0)=0
 Returns a Memory that can be written to, and is guaranteed to have at least sizeHint elements. More...
 
virtual System::Span< T > GetSpan (int32_t sizeHint=0)=0
 Returns a Span that can be written to, and is guaranteed to have at least sizeHint elements. 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...
 

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

template<typename T>
class System::Buffers::ArrayBufferWriter< T >

Represents a heap-based, array-backed output sink into which data can be written.

Template Parameters
TThe type of the elements held by the writer.

Constructor & Destructor Documentation

◆ ArrayBufferWriter() [1/2]

template<typename T >
System::Buffers::ArrayBufferWriter< T >::ArrayBufferWriter ( )
inline

Creates an instance of an ArrayBufferWriter, in which data can be written to, with the default initial capacity.

◆ ArrayBufferWriter() [2/2]

template<typename T >
System::Buffers::ArrayBufferWriter< T >::ArrayBufferWriter ( int32_t  initialCapacity)
inlineexplicit

Creates an instance of an ArrayBufferWriter, in which data can be written to, with an initial capacity specified.

Parameters
initialCapacityThe minimum capacity with which to initialize the underlying buffer.
Exceptions
ArgumentExceptionIf initialCapacity is not positive (i.e. less than or equal to 0).

Member Function Documentation

◆ Advance()

template<typename T >
void System::Buffers::ArrayBufferWriter< T >::Advance ( int32_t  count)
inlineoverridevirtual

Notifies the writer that count amount of data was written to the output Span/Memory.

Parameters
countThe number of elements that were written.
Exceptions
ArgumentExceptionIf count is negative.
InvalidOperationExceptionIf attempting to advance past the end of the underlying buffer.
Note
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.

Implements System::Buffers::IBufferWriter< T >.

◆ Clear()

template<typename T >
void System::Buffers::ArrayBufferWriter< T >::Clear ( )
inline

Clears the data written to the underlying buffer.

Note
You must reset or clear the ArrayBufferWriter before trying to re-use it.
The ResetWrittenCount method is faster since it only sets to zero the writer's index while the Clear method additionally zeroes the content of the underlying buffer.
See also
ResetWrittenCount

◆ get_Capacity()

template<typename T >
int32_t System::Buffers::ArrayBufferWriter< T >::get_Capacity ( ) const
inline

Returns the total amount of space within the underlying buffer.

Returns
The total capacity of the underlying buffer.

◆ get_FreeCapacity()

template<typename T >
int32_t System::Buffers::ArrayBufferWriter< T >::get_FreeCapacity ( ) const
inline

Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.

Returns
The free capacity of the underlying buffer.

◆ get_WrittenCount()

template<typename T >
int32_t System::Buffers::ArrayBufferWriter< T >::get_WrittenCount ( ) const
inline

Returns the amount of data written to the underlying buffer so far.

Returns
The count of written elements.

◆ get_WrittenMemory()

template<typename T >
ReadOnlyMemory< T > System::Buffers::ArrayBufferWriter< T >::get_WrittenMemory ( ) const
inline

Returns the data written to the underlying buffer so far, as a ReadOnlyMemory.

Returns
A ReadOnlyMemory covering the written data.

◆ get_WrittenSpan()

template<typename T >
ReadOnlySpan< T > System::Buffers::ArrayBufferWriter< T >::get_WrittenSpan ( ) const
inline

Returns the data written to the underlying buffer so far, as a ReadOnlySpan.

Returns
A ReadOnlySpan covering the written data.

◆ GetMemory()

template<typename T >
Memory< T > System::Buffers::ArrayBufferWriter< T >::GetMemory ( int32_t  sizeHint = 0)
inlineoverridevirtual

Returns a Memory to write to that is at least the requested length (specified by sizeHint). If no sizeHint is provided (or it's equal to 0), some non-empty buffer is returned.

Parameters
sizeHintThe minimum number of elements that must be available.
Returns
A Memory that can be written to.
Exceptions
ArgumentExceptionIf sizeHint is negative.
Note
This will never return an empty Memory.
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.

Implements System::Buffers::IBufferWriter< T >.

◆ GetSpan()

template<typename T >
Span< T > System::Buffers::ArrayBufferWriter< T >::GetSpan ( int32_t  sizeHint = 0)
inlineoverridevirtual

Returns a Span to write to that is at least the requested length (specified by sizeHint). If no sizeHint is provided (or it's equal to 0), some non-empty buffer is returned.

Parameters
sizeHintThe minimum number of elements that must be available.
Returns
A Span that can be written to.
Exceptions
ArgumentExceptionIf sizeHint is negative.
Note
This will never return an empty Span.
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.

Implements System::Buffers::IBufferWriter< T >.

◆ ResetWrittenCount()

template<typename T >
void System::Buffers::ArrayBufferWriter< T >::ResetWrittenCount ( )
inline

Resets the data written to the underlying buffer without zeroing its content.

Note
You must reset or clear the ArrayBufferWriter before trying to re-use it.
See also
Clear