Class H5ReadOptions

Namespace

PureHDF

Assembly

PureHDF.dll

Provides options to be used with H5File.

public record H5ReadOptions : IEquatable<H5ReadOptions>

Inheritance

object

H5ReadOptions

Implements

IEquatable<H5ReadOptions>

Constructors

H5ReadOptions(H5ReadOptions)

protected H5ReadOptions(H5ReadOptions original)

Parameters

original H5ReadOptions

H5ReadOptions(bool, bool, bool, bool, Func<FieldInfo, string?>?, Func<PropertyInfo, string?>?)

Provides options to be used with H5File.

public H5ReadOptions(bool IncludeStructFields = true, bool IncludeStructProperties = false, bool IncludeClassFields = false, bool IncludeClassProperties = true, Func<FieldInfo, string?>? FieldNameMapper = null, Func<PropertyInfo, string?>? PropertyNameMapper = null)

Parameters

IncludeStructFields bool

A value that indicates whether struct fields are handled during serialization. The default value is true.

IncludeStructProperties bool

A value that indicates whether struct properties are handled during serialization. The default value is false.

IncludeClassFields bool

A value that indicates whether class fields are handled during serialization. The default value is false.

IncludeClassProperties bool

A value that indicates whether class properties are handled during serialization. The default value is true.

FieldNameMapper Func<FieldInfo, string>

Maps a FieldInfo to the name of the HDF5 member.

PropertyNameMapper Func<PropertyInfo, string>

Maps a PropertyInfo to the name of the HDF5 member.

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

FieldNameMapper

Maps a FieldInfo to the name of the HDF5 member.

public Func<FieldInfo, string?>? FieldNameMapper { get; init; }

Property Value

Func<FieldInfo, string>

IncludeClassFields

A value that indicates whether class fields are handled during serialization. The default value is false.

public bool IncludeClassFields { get; init; }

Property Value

bool

IncludeClassProperties

A value that indicates whether class properties are handled during serialization. The default value is true.

public bool IncludeClassProperties { get; init; }

Property Value

bool

IncludeStructFields

A value that indicates whether struct fields are handled during serialization. The default value is true.

public bool IncludeStructFields { get; init; }

Property Value

bool

IncludeStructProperties

A value that indicates whether struct properties are handled during serialization. The default value is false.

public bool IncludeStructProperties { get; init; }

Property Value

bool

PropertyNameMapper

Maps a PropertyInfo to the name of the HDF5 member.

public Func<PropertyInfo, string?>? PropertyNameMapper { get; init; }

Property Value

Func<PropertyInfo, string>

Methods

Deconstruct(out bool, out bool, out bool, out bool, out Func<FieldInfo, string?>?, out Func<PropertyInfo, string?>?)

public void Deconstruct(out bool IncludeStructFields, out bool IncludeStructProperties, out bool IncludeClassFields, out bool IncludeClassProperties, out Func<FieldInfo, string?>? FieldNameMapper, out Func<PropertyInfo, string?>? PropertyNameMapper)

Parameters

IncludeStructFields bool

IncludeStructProperties bool

IncludeClassFields bool

IncludeClassProperties bool

FieldNameMapper Func<FieldInfo, string>

PropertyNameMapper Func<PropertyInfo, string>

Equals(H5ReadOptions?)

public virtual bool Equals(H5ReadOptions? other)

Parameters

other H5ReadOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

<Clone>$()

public virtual H5ReadOptions <Clone>$()

Returns

H5ReadOptions

Operators

operator ==(H5ReadOptions?, H5ReadOptions?)

public static bool operator ==(H5ReadOptions? left, H5ReadOptions? right)

Parameters

left H5ReadOptions

right H5ReadOptions

Returns

bool

operator !=(H5ReadOptions?, H5ReadOptions?)

public static bool operator !=(H5ReadOptions? left, H5ReadOptions? right)

Parameters

left H5ReadOptions

right H5ReadOptions

Returns

bool