CompressionSettings Class Reference

Configures data compression More...

Inherits IEquatable< CompressionSettings >.

Public Member Functions
CompressionSettings	With (Action< CompressionSettingsBuilder > build)
	Creates a new CompressionSettings with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (CompressionSettings other)
	Compares for equality More...

Static Public Attributes
const uint	BestCompressionLevel
	Specifies the WriterCompressionLevel with the best compression possible for a compression algorithm. More...
const uint	BestSpeedCompressionLevel
	Specifies the WriterCompressionLevel with the best speed possible for a compression algorithm. More...
const uint	DefaultCompressionLevel
	The default WriterCompressionLevel. More...
const uint	DefaultCompressionThreshold
	The default WriterCompressionThreshold. More...

Properties
CompressionId	CompressionIds [get]
	Mask that represents the compression algorithms enabled. More...
uint	WriterCompressionLevel [get]
	The level of compression to use when compressing data. More...
int	WriterCompressionThreshold [get]
	The threshold, in bytes, above which a serialized sample will be eligible to be compressed. More...
static CompressionSettings	Default [get]
	Singleton containing the default value of a CompressionSettings More...

Detailed Description

Configures data compression

Member Function Documentation

Equals() [1/2]

bool Equals

(

CompressionSettings

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

CompressionSettings With

(

Action< CompressionSettingsBuilder >

build

)

Creates a new CompressionSettings with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this CompressionSettings.

Returns

A new CompressionSettings with the changes applied by the Action

Member Data Documentation

BestCompressionLevel

const uint BestCompressionLevel

static

Specifies the WriterCompressionLevel with the best compression possible for a compression algorithm.

BestSpeedCompressionLevel

const uint BestSpeedCompressionLevel

static

Specifies the WriterCompressionLevel with the best speed possible for a compression algorithm.

DefaultCompressionLevel

const uint DefaultCompressionLevel

static

The default WriterCompressionLevel.

DefaultCompressionThreshold

const uint DefaultCompressionThreshold

static

The default WriterCompressionThreshold.

Property Documentation

CompressionIds

CompressionId CompressionIds

get

Mask that represents the compression algorithms enabled.

The full documentation is available in the C API: DDS_CompressionSettings_t::compression_ids

Default

CompressionSettings Default

staticget

Singleton containing the default value of a CompressionSettings

WriterCompressionLevel

uint WriterCompressionLevel

get

The level of compression to use when compressing data.

The full documentation is available in the C API: DDS_CompressionSettings_t::writer_compression_level

WriterCompressionThreshold

int WriterCompressionThreshold

get

The threshold, in bytes, above which a serialized sample will be eligible to be compressed.

The full documentation is available in the C API: DDS_CompressionSettings_t::writer_compression_threshold