Aspose::Brotli::BrotliStream Class Referencefinal

A class for compressing and decompressing streams using the Brotli algorithm. More...

Inherits System::IO::Stream.

Public Types

typedef System::SharedPtr< BrotliStreamPtr
 Pointer type. More...
 
- Public Types inherited from System::IO::Stream
typedef SharedPtr< StreamPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 BrotliStream ()=delete
 
 BrotliStream (const BrotliStream &)=delete
 
ASPOSECPP_SHARED_API BrotliStream (const System::IO::Stream::Ptr &stream, System::IO::Compression::CompressionMode mode)
 
ASPOSECPP_SHARED_API BrotliStream (const System::IO::Stream::Ptr &stream, System::IO::Compression::CompressionMode mode, bool leaveOpen)
 
ASPOSECPP_SHARED_API BrotliStream (const System::IO::Stream::Ptr &stream, System::IO::Compression::CompressionLevel level, bool leaveOpen=false)
 
ASPOSECPP_SHARED_API BrotliStream (const System::IO::Stream::Ptr &stream, System::IO::Compression::CompressionMode mode, System::IO::Compression::CompressionLevel level, bool leaveOpen=false)
 
ASPOSECPP_SHARED_API ~BrotliStream ()
 Destructor. More...
 
ASPOSECPP_SHARED_API int32_t Read (const System::ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count) override
 
ASPOSECPP_SHARED_API int32_t Read (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count) override
 
ASPOSECPP_SHARED_API void Write (const System::ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count) override
 
ASPOSECPP_SHARED_API void Write (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count) override
 
ASPOSECPP_SHARED_API int64_t Seek (int64_t offset, System::IO::SeekOrigin origin) override
 
ASPOSECPP_SHARED_API void SetLength (int64_t value) override
 
ASPOSECPP_SHARED_API void Flush () override
 Clears this stream's buffers and writes all buffered data to the underlying storage. More...
 
ASPOSECPP_SHARED_API System::StreamPtr get_BaseStream () const
 
ASPOSECPP_SHARED_API bool get_CanSeek () const override
 
ASPOSECPP_SHARED_API bool get_CanRead () const override
 
ASPOSECPP_SHARED_API bool get_CanWrite () const override
 
ASPOSECPP_SHARED_API void set_Position (int64_t value) override
 
ASPOSECPP_SHARED_API int64_t get_Position () const override
 
ASPOSECPP_SHARED_API int64_t get_Length () const override
 
ASPOSECPP_SHARED_API void SetQuality (int quality)
 
ASPOSECPP_SHARED_API void SetMode (int mode)
 
ASPOSECPP_SHARED_API void SetWindow (int windowSize)
 
ASPOSECPP_SHARED_API void Close () override
 Closes the stream. More...
 
- Public Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API int ReadByte ()
 
virtual ASPOSECPP_SHARED_API void WriteByte (uint8_t value)
 
template<std::size_t N>
int32_t Read (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 
template<std::size_t N>
void Write (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 
ASPOSECPP_SHARED_API void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual ASPOSECPP_SHARED_API void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination)
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 
virtual ASPOSECPP_SHARED_API bool get_CanTimeout () const
 
virtual ASPOSECPP_SHARED_API void set_ReadTimeout (int timeout)
 Sets a value that determines whether the current stream can time out. More...
 
virtual ASPOSECPP_SHARED_API int get_ReadTimeout () const
 
virtual ASPOSECPP_SHARED_API void set_WriteTimeout (int timeout)
 Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual ASPOSECPP_SHARED_API int get_WriteTimeout () const
 Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. More...
 
- 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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)
 

Static Public Member Functions

static ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > CompressBuffer (const System::ArrayPtr< uint8_t > &b)
 
static ASPOSECPP_SHARED_API size_t UncompressBuffer (const System::ArrayPtr< uint8_t > &compressed, System::ArrayPtr< uint8_t > &destination)
 
- 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Additional Inherited Members

- Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API Null
 A stream with no underlying storage. More...
 

Detailed Description

A class for compressing and decompressing streams using the Brotli algorithm.

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ BrotliStream() [1/6]

Aspose::Brotli::BrotliStream::BrotliStream ( )
delete

◆ BrotliStream() [2/6]

Aspose::Brotli::BrotliStream::BrotliStream ( const BrotliStream )
delete

◆ BrotliStream() [3/6]

ASPOSECPP_SHARED_API Aspose::Brotli::BrotliStream::BrotliStream ( const System::IO::Stream::Ptr stream,
System::IO::Compression::CompressionMode  mode 
)

Constructor. Closes the stream after being processed.

Parameters
streamStream to be compressed or uncompressed.
modeDirection (compression or decompression).

◆ BrotliStream() [4/6]

ASPOSECPP_SHARED_API Aspose::Brotli::BrotliStream::BrotliStream ( const System::IO::Stream::Ptr stream,
System::IO::Compression::CompressionMode  mode,
bool  leaveOpen 
)

Constructor.

Parameters
streamStream to be compressed or uncompressed.
modeDirection (compression or decompression).
leaveOpenWhether to close stream (false) or not (true) after processing.

◆ BrotliStream() [5/6]

ASPOSECPP_SHARED_API Aspose::Brotli::BrotliStream::BrotliStream ( const System::IO::Stream::Ptr stream,
System::IO::Compression::CompressionLevel  level,
bool  leaveOpen = false 
)

Constructor. Uses 'Compress' mode.

Parameters
streamStream to be compressed or uncompressed.
levelCompression mode to be applied.
leaveOpenWhether to close stream (false) or not (true) after processing.

◆ BrotliStream() [6/6]

ASPOSECPP_SHARED_API Aspose::Brotli::BrotliStream::BrotliStream ( const System::IO::Stream::Ptr stream,
System::IO::Compression::CompressionMode  mode,
System::IO::Compression::CompressionLevel  level,
bool  leaveOpen = false 
)

Constructor.

Parameters
streamStream to be compressed or uncompressed.
modeDirection (compression or decompression).
levelCompression mode to be applied.
leaveOpenWhether to close stream (false) or not (true) after processing.

◆ ~BrotliStream()

ASPOSECPP_SHARED_API Aspose::Brotli::BrotliStream::~BrotliStream ( )

Destructor.

Member Function Documentation

◆ Close()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::Close ( )
overridevirtual

Closes the stream.

Reimplemented from System::IO::Stream.

◆ CompressBuffer()

static ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> Aspose::Brotli::BrotliStream::CompressBuffer ( const System::ArrayPtr< uint8_t > &  b)
static

Compresses byte sequence.

Parameters
bBytes to compress.
Returns
Compressed data.

◆ Flush()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::Flush ( )
overridevirtual

Clears this stream's buffers and writes all buffered data to the underlying storage.

Implements System::IO::Stream.

◆ get_BaseStream()

ASPOSECPP_SHARED_API System::StreamPtr Aspose::Brotli::BrotliStream::get_BaseStream ( ) const

Gets a reference to the underlying stream.

Returns
A pointer to the underlying stream.

◆ get_CanRead()

ASPOSECPP_SHARED_API bool Aspose::Brotli::BrotliStream::get_CanRead ( ) const
overridevirtual

Determines if the stream is readable.

Returns
True if the stream is readable; otherwise - false

Implements System::IO::Stream.

◆ get_CanSeek()

ASPOSECPP_SHARED_API bool Aspose::Brotli::BrotliStream::get_CanSeek ( ) const
overridevirtual

Checks whether the stream can seek.

Returns
Always returns false.

Implements System::IO::Stream.

◆ get_CanWrite()

ASPOSECPP_SHARED_API bool Aspose::Brotli::BrotliStream::get_CanWrite ( ) const
overridevirtual

Determines if the stream is writable.

Returns
True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_Length()

ASPOSECPP_SHARED_API int64_t Aspose::Brotli::BrotliStream::get_Length ( ) const
overridevirtual

Returns the length of the stream in bytes.

Returns
The length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Position()

ASPOSECPP_SHARED_API int64_t Aspose::Brotli::BrotliStream::get_Position ( ) const
overridevirtual

Returns the current position of the stream.

Returns
The current position of the stream.

Implements System::IO::Stream.

◆ Read() [1/2]

ASPOSECPP_SHARED_API int32_t Aspose::Brotli::BrotliStream::Read ( const System::ArrayPtr< uint8_t > &  buffer,
int32_t  offset,
int32_t  count 
)
overridevirtual

Reads the specified number of bytes from the stream and writes them to the specified byte array.

Parameters
bufferThe byte array to write the read bytes to
offsetA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
The number of bytes read

Implements System::IO::Stream.

◆ Read() [2/2]

ASPOSECPP_SHARED_API int32_t Aspose::Brotli::BrotliStream::Read ( const System::Details::ArrayView< uint8_t > &  buffer,
int32_t  offset,
int32_t  count 
)
overridevirtual

Reads the specified number of bytes from the stream and writes them to the specified byte array view.

Parameters
bufferThe byte array view to write the read bytes to
offsetA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
The number of bytes read

Reimplemented from System::IO::Stream.

◆ Seek()

ASPOSECPP_SHARED_API int64_t Aspose::Brotli::BrotliStream::Seek ( int64_t  offset,
System::IO::SeekOrigin  origin 
)
overridevirtual

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

Parameters
offsetThe byte offset relative to a position specified by origin
originSpecifies the position from which and the direction toward which the offset is calculated
Returns
The new position of the stream

Implements System::IO::Stream.

◆ set_Position()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::set_Position ( int64_t  value)
overridevirtual

Sets the stream's position.

Parameters
valueThe byte offset to set the stream's position to

Implements System::IO::Stream.

◆ SetLength()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::SetLength ( int64_t  value)
overridevirtual

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

Parameters
valueThe length in bytes to set

Implements System::IO::Stream.

◆ SetMode()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::SetMode ( int  mode)

Tune encoder for specific input.

Parameters
modeCompress mode.

◆ SetQuality()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::SetQuality ( int  quality)

Set compress level for stream.

Parameters
qualityCompress level.

◆ SetWindow()

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::SetWindow ( int  windowSize)

Sets the window size for the encoder.

Parameters
windowSizeThe window size in bits (a value from 10-24).

◆ UncompressBuffer()

static ASPOSECPP_SHARED_API size_t Aspose::Brotli::BrotliStream::UncompressBuffer ( const System::ArrayPtr< uint8_t > &  compressed,
System::ArrayPtr< uint8_t > &  destination 
)
static

Uncompresses byte sequence.

Parameters
compressedData to uncompress.
Returns
Uncompressed data.

◆ Write() [1/2]

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::Write ( const System::ArrayPtr< uint8_t > &  buffer,
int32_t  offset,
int32_t  count 
)
overridevirtual

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

Parameters
bufferThe array containing the bytes to write
offsetA 0-based index of the element in buffer at which the subrange to write begins
countThe number of elements in the subrange to write

Implements System::IO::Stream.

◆ Write() [2/2]

ASPOSECPP_SHARED_API void Aspose::Brotli::BrotliStream::Write ( const System::Details::ArrayView< uint8_t > &  buffer,
int32_t  offset,
int32_t  count 
)
overridevirtual

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

Parameters
bufferThe array view containing the bytes to write
offsetA 0-based index of the element in buffer at which the subrange to write begins
countThe number of elements in the subrange to write

Reimplemented from System::IO::Stream.