nlib
nn::nlib::ZlibInputStreamSettings Struct Reference

The structure that stores the various ZlibInputStream settings. At construction time, the default settings are stored. More...

#include "nn/nlib/ZlibInputStream.h"

Public Types

typedef void *(* ReallocFunc) (void *p, size_t n)
 The type for functions compatible with realloc.
 

Public Member Functions

constexpr ZlibInputStreamSettings () noexcept
 Instantiates the object with default parameters (default constructor). Sets the default values.
 
constexpr ZlibInputStreamSettings (void *buf_in_, void *buf_out_, size_t buffer_size_) noexcept
 Sets the individual data members.
 
constexpr ZlibInputStreamSettings (void *buf_in_, void *buf_out_, size_t buffer_size_, ReallocFunc realloc_func_) noexcept
 Sets the individual data members.
 

Public Attributes

void * buf_in
 The buffer set for z_stream::next_in. More...
 
void * buf_out
 The buffer set for z_stream::next_out. More...
 
size_t buffer_size
 The size of ZlibInputStreamSettings::buf_in and ZlibInputStreamSettings::buf_out. More...
 
ReallocFunc realloc_func
 The realloc function or its equivalent that ZlibInputStream uses internally. More...
 

Detailed Description

The structure that stores the various ZlibInputStream settings. At construction time, the default settings are stored.

Examples:
misc/usezlib/usezlib.cpp.

Definition at line 14 of file ZlibInputStream.h.

Member Data Documentation

§ buf_in

nn::nlib::ZlibInputStreamSettings::buf_in

The buffer set for z_stream::next_in.

Description
If NULL is specified, ZlibInputStream acts internally to allocate a buffer. If you specify NULL, you also must specify NULL for buf_out.
The default is NULL.

Definition at line 16 of file ZlibInputStream.h.

§ buf_out

nn::nlib::ZlibInputStreamSettings::buf_out

The buffer set for z_stream::next_out.

Description
If NULL is specified, ZlibInputStream acts internally to allocate a buffer. If you specify NULL, you also must specify NULL for buf_in.
The default is NULL.

Definition at line 17 of file ZlibInputStream.h.

§ buffer_size

nn::nlib::ZlibInputStreamSettings::buffer_size

The size of ZlibInputStreamSettings::buf_in and ZlibInputStreamSettings::buf_out.

Description
You must set this value to 1024 or greater. The default is 65536.

Definition at line 18 of file ZlibInputStream.h.

§ realloc_func

nn::nlib::ZlibInputStreamSettings::realloc_func

The realloc function or its equivalent that ZlibInputStream uses internally.

Description
The default setting is the C standard realloc function.

Definition at line 19 of file ZlibInputStream.h.


The documentation for this struct was generated from the following files: