Value

References

public sealed class Value : IEquatable<Value>

Represents a single immutable value in an archive.

Constructors

Value

public Value(IEnumerable<BigInteger> values)

Parameters:

values (IEnumerable<BigInteger>)

Value

public Value(IEnumerable<bool> values)

Parameters:

values (IEnumerable<bool>)

Value

public Value(IEnumerable<byte> values)

Parameters:

values (IEnumerable<byte>)

Value

public Value(IEnumerable<Complex> values)

Parameters:

values (IEnumerable<Complex>)

Value

public Value(IEnumerable<DateTime> values)

Parameters:

values (IEnumerable<DateTime>)

Value

public Value(IEnumerable<decimal> values)

Parameters:

values (IEnumerable<decimal>)

Value

public Value(IEnumerable<double> values)

Parameters:

values (IEnumerable<double>)

Value

public Value(IEnumerable<float> values)

Parameters:

values (IEnumerable<float>)

Value

public Value(IEnumerable<Guid> values)

Parameters:

values (IEnumerable<Guid>)

Value

public Value(IEnumerable<int> values)

Parameters:

values (IEnumerable<int>)

Value

public Value(IEnumerable<long> values)

Parameters:

values (IEnumerable<long>)

Value

public Value(IEnumerable<string> values)

Parameters:

values (IEnumerable<string>)

Value

public Value(IEnumerable<uint> values)

Parameters:

values (IEnumerable<uint>)

Value

public Value(IEnumerable<ulong> values)

Parameters:

values (IEnumerable<ulong>)

Value

public Value(IEnumerable<Version> values)

Parameters:

values (IEnumerable<Version>)

Properties

Count

public int Count { get; }

Gets the number of items stored in this entry. If the entry does not represent an array, this property always returns one. If the entry does represent an array, the length of the array is returned.

GetBigInteger

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public BigInteger GetBigInteger { get; }

Get the big integer inside this entry.

GetBigIntegerArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public BigInteger[] GetBigIntegerArray { get; }

Get the BigInteger array inside this entry.

GetBoolean

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public bool GetBoolean { get; }

Get the boolean inside this entry.

GetBooleanArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public bool[] GetBooleanArray { get; }

Get the boolean array inside this entry.

GetByte

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public byte GetByte { get; }

Get the byte inside this entry.

GetByteArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public byte[] GetByteArray { get; }

Get the byte array inside this entry.

GetComplex

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Complex GetComplex { get; }

Get the complex number inside this entry.

GetComplexArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Complex[] GetComplexArray { get; }

Get the complex number array inside this entry.

GetDateTime

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public DateTime GetDateTime { get; }

Get the date inside this entry.

GetDateTimeArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public DateTime[] GetDateTimeArray { get; }

Get the date array inside this entry.

GetDecimal

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public decimal GetDecimal { get; }

Get the decimal inside this entry.

GetDecimalArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public decimal[] GetDecimalArray { get; }

Get the decimal array inside this entry.

GetFilePath

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public AbsRelPaths GetFilePath { get; }

Get the file path inside this entry.

GetFloat32

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public float GetFloat32 { get; }

Get the float inside this entry.

GetFloat32Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public float[] GetFloat32Array { get; }

Get the float array inside this entry.

GetFloat64

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public double GetFloat64 { get; }

Get the double inside this entry.

GetFloat64Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public double[] GetFloat64Array { get; }

Get the double array inside this entry.

GetGuid

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Guid GetGuid { get; }

Get the Guid inside this entry.

GetGuidArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Guid[] GetGuidArray { get; }

Get the Guid array inside this entry.

GetInteger32

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public int GetInteger32 { get; }

Get the int inside this entry.

GetInteger32Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public int[] GetInteger32Array { get; }

Get the int array inside this entry.

GetInteger64

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public long GetInteger64 { get; }

Get the long inside this entry.

GetInteger64Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public long[] GetInteger64Array { get; }

Get the long array inside this entry.

GetString

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public string GetString { get; }

Get the string inside this entry.

GetStringArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public string[] GetStringArray { get; }

Get the string array inside this entry.

GetTimeSpan

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public TimeSpan GetTimeSpan { get; }

Get the date inside this entry.

GetUInteger32

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public uint GetUInteger32 { get; }

Get the uint inside this entry.

GetUInteger32Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public uint[] GetUInteger32Array { get; }

Get the uint array inside this entry.

GetUInteger64

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public ulong GetUInteger64 { get; }

Get the ulong inside this entry.

GetUInteger64Array

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public ulong[] GetUInteger64Array { get; }

Get the ulong array inside this entry.

GetVersion

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Version GetVersion { get; }

Get the version inside this entry.

GetVersionArray

[DebuggerBrowsable(DebuggerBrowsableState.Never)] public Version[] GetVersionArray { get; }

Get the version array inside this entry.

IsArray

public bool IsArray { get; }

Gets whether this entry stores an array of values.

RawData

public object RawData { get; }

Gets the raw data stored in this entry. There are also type-safe accessors available which you should consider using. Internal data is supposed to be immutable, so when you use this accessor to modify the state of the raw data you may cause all sorts of problems.

SizeEstimate

public int SizeEstimate { get; }

Gets an estimate of the number of bytes this value takes up when written to file. Note that this will differ from the size taken up in memory at runtime. Also note that the values will sometimes be estimations rather than the actual value, as determining the actual size would require a lot of resources.

Type

public DataType Type { get; }

Gets the type for this entry.

Methods

AreIndentical

public static bool AreIndentical(Value a, Value b)

Test two entries for equality. This comparison (unlike Equals and CompareTo) test both the location and value of the entry.

Parameters:

a (Value)	First entry.
b (Value)	Second entry.

Returns: True if entries are identical.

DeserializeObject<T>

public T DeserializeObject<T>()

Deserialize an object from the internal data.

Returns: The deserialized object.

Equals

public override bool Equals(object obj)

Parameters:

obj (object)

Overrides: Object.Equals

Equals

public bool Equals(Value other)

Parameters:

other (Value)

FromObject

public static Value FromObject(object value)

Stores a generic object. The object must either provide its own deserialization via the Serializable attribute or the ISerializable interface, or it must be supported as one of the standard types via the System.Runtime.Serialization.Formatters.Binary.BinaryFormatter class. The object will be stored as a byte-array.

Parameters:

value (object)

Object to serialize.

GetHashCode

public override int GetHashCode()

Overrides: Object.GetHashCode

Read

public static void Read(BinaryReader reader, out Value entry)

Read an entry from a binary reader.

Parameters:

reader (BinaryReader)	Reader object.
entry (out Value)	Deserialized entry.

ToString

public override string ToString()

Gets a string representation of this item. This conversion can be lossy.

Overrides: Object.ToString

Write

public static void Write(BinaryWriter writer, Value entry)

Write an entry to an archive.

Parameters:

writer (BinaryWriter)	Writer object.
entry (Value)	Entry to serialize.

Convertors

		Result
implicit	AbsRelPaths	Value
implicit	AbsRelPaths[]	Value
implicit	BigInteger	Value
implicit	BigInteger[]	Value
implicit	bool	Value
implicit	bool[]	Value
implicit	byte	Value
implicit	byte[]	Value
implicit	Complex	Value
implicit	Complex[]	Value
implicit	DateTime	Value
implicit	DateTime[]	Value
implicit	decimal	Value
implicit	decimal[]	Value
implicit	double	Value
implicit	double[]	Value
implicit	float	Value
implicit	float[]	Value
implicit	Guid	Value
implicit	Guid[]	Value
implicit	int	Value
implicit	int[]	Value
implicit	long	Value
implicit	long[]	Value
implicit	string	Value
implicit	string[]	Value
implicit	TimeSpan	Value
implicit	TimeSpan[]	Value
implicit	uint	Value
implicit	uint[]	Value
implicit	ulong	Value
implicit	ulong[]	Value
implicit	Version	Value
implicit	Version[]	Value