IReader

References
public interface IReader
Provides access to a subset of Node methods used for writing archives.

Properties

Name

#
Name Name { get; }
Gets the name of this reader.

Methods

Boolean

#
bool Boolean(Name name)
Read a boolean value.
Parameters:
name (Name)Name of item.
Returns: Boolean value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

BooleanArray

#
bool[] BooleanArray(Name name)
Read a boolean array.
Parameters:
name (Name)Name of item.
Returns: Boolean array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Complex128

#
Complex Complex128(Name name)
Read a complex number value.
Parameters:
name (Name)Name of item.
Returns: Decimal point value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

DateTime

#
DateTime DateTime(Name name)
Read a datetime value.
Parameters:
name (Name)Name of item.
Returns: Datetime value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Decimal128

#
decimal Decimal128(Name name)
Read a decimal value.
Parameters:
name (Name)Name of item.
Returns: Decimal point value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

FilePath

#
AbsRelPaths FilePath(Name name)
Read a file path value.
Parameters:
name (Name)Name of item.
Returns: File path value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

FindItem

#
Value FindItem(Name name)
Get the value associatd with the specified name and index.
Parameters:
name (Name)Name of value to find.
Returns: The value linked to the given name and index or null if no such value exists.

FindReader

#
IReader FindReader(Name name)
Find the reader sub-object by name and index.
Parameters:
name (Name)Name of reader to find.
Returns: The reader identified by the name and index or null if no such reader exists.

GenericArray<T>

#
T[] GenericArray<T>(Name name)
Restore an array of values. This method only works if SupportsArray<T>() returns true for the same type constraint.
Parameters:
name (Name)Name of item.
Returns: Restored values.

Guid128

#
Guid Guid128(Name name)
Read a Guid value.
Parameters:
name (Name)Name of item.
Returns: Guid value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

GuidArray

#
Guid[] GuidArray(Name name)
Read a Guid array.
Parameters:
name (Name)Name of item.
Returns: Guid array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

HasItem

#
bool HasItem(Name name, DataType storageType)
Test whether a certain item exists.
Parameters:
name (Name)Name of item to find.
storageType (DataType)Item type constraint.
Returns: True if such an item exists within this reader.

HasItem

#
bool HasItem(Name name)
Test whether a certain item exists.
Parameters:
name (Name)Name of item to find.
Returns: True if such an item exists within this reader.

HasItemOrNode

#
bool HasItemOrNode(Name name)
Gets whether the specified name is available as either an item, or a node.
Parameters:
name (Name)

HasNode

#
bool HasNode(Name name)
Test whether a certain child node/reader exists.
Parameters:
name (Name)Name of node/reader to find.
Returns: True if node/reader is defined.

Integer32

#
int Integer32(Name name)
Read an integer value.
Parameters:
name (Name)Name of item.
Returns: Integer value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Integer32Array

#
int[] Integer32Array(Name name)
Read an integer array.
Parameters:
name (Name)Name of item.
Returns: Integer array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Integer64

#
long Integer64(Name name)
Read an integer value.
Parameters:
name (Name)Name of item.
Returns: Integer value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Integer64Array

#
long[] Integer64Array(Name name)
Read an integer array.
Parameters:
name (Name)Name of item.
Returns: Integer array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Integer8

#
byte Integer8(Name name)
Read a byte value.
Parameters:
name (Name)Name of item.
Returns: Byte value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Integer8Array

#
byte[] Integer8Array(Name name)
Read a byte array.
Parameters:
name (Name)Name of item.
Returns: Byte array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

IntegerXx

#
BigInteger IntegerXx(Name name)
Read an integer value.
Parameters:
name (Name)Name of item.
Returns: Integer value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Number32

#
float Number32(Name name)
Read a floating point value.
Parameters:
name (Name)Name of item.
Returns: Floating point value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Number32Array

#
float[] Number32Array(Name name)
Read a float array.
Parameters:
name (Name)Name of item.
Returns: Float array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Number64

#
double Number64(Name name)
Read a floating point value.
Parameters:
name (Name)Name of item.
Returns: Floating point value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Number64Array

#
double[] Number64Array(Name name)
Read a float array.
Parameters:
name (Name)Name of item.
Returns: Float array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Storable

#
IStorable Storable(Name name)
Read a storable object. This method requires that the object was originally written using IWriter.WriteStorable, that the type of the original value had an IdentifierAttribute associated with it and that that identifier is known in the current running context.
Parameters:
name (Name)Inner name for data. If null, the current reader will be used.

Storable<T>

#
T Storable<T>(Name name)
Read a storable object of a specific type. default(T) will be returned if the name does not point to a valid block.
Parameters:
name (Name)Inner name for data. If null, the current reader will be used.

StorableArray<T>

#
T[] StorableArray<T>(Name name)
Read a collection of storable objects.
Parameters:
name (Name)

String

#
string String(Name name)
Read a string value.
Parameters:
name (Name)Name of item.
Returns: String value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

StringArray

#
string[] StringArray(Name name)
Read a string array.
Parameters:
name (Name)Name of item.
Returns: String array.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

SupportsArray<T>

#
bool SupportsArray<T>()
Gets whether an array of type T can be automatically restored.
Returns: True if an array of type T can be automatically restored.

TimeSpan

#
TimeSpan TimeSpan(Name name)
Read a datetime value.
Parameters:
name (Name)Name of item.
Returns: Datetime value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

TryRead<T>

#
T TryRead<T>(Name name, T valueIfMissing)
Try and read a value if it exists.
Parameters:
name (Name)Name of value.
valueIfMissing (T)Value to return if there is no item with the given name.
Returns: Read value or default.

Type

#
Type Type(Name name, IEnumerable<Type> fallbackList, out Type fallback)
Read a type value. Since a type may not be loaded during read, this operation may fail. A list of possible fallback types may be specified, and an identically named one will be picked if the exact type is not found.
Parameters:
name (Name)
fallbackList (IEnumerable<Type>)
fallback (out Type)

Type

#
Type Type(Name name)
Read a type value. Since a type may not be loaded during read, this operation may fail.
Parameters:
name (Name)Name of item.
Returns: Type value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

TypeName

#
string TypeName(Name name)
Read the assembly qualified name of the type.
Parameters:
name (Name)Name of item.
Returns: Type name value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.

Version

#
Version Version(Name name)
Read a version value.
Parameters:
name (Name)Name of item.
Returns: Version value.
Exceptions:
KeyNotFoundExceptionThrown when the requested name+index do not exist.