Struct BigSize

Namespace

NLightning.Common.Types

Assembly

NLightning.Common.dll

Represents a variable length integer.

public readonly struct BigSize : IComparable

Implements

IComparable

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Initializes a new instance of the BigSize struct.

Constructors

BigSize(ulong)

Represents a variable length integer.

public BigSize(ulong value)

Parameters

value ulong

The value of the big size.

Remarks

Initializes a new instance of the BigSize struct.

Properties

Value

The uint representation of the big size.

public ulong Value { get; }

Property Value

ulong

Methods

CompareTo(object?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

DeserializeAsync(Stream)

Deserializes a big size from a BinaryReader.

public static Task<BigSize> DeserializeAsync(Stream stream)

Parameters

stream Stream

The stream to deserialize from.

Returns

Task<BigSize>

The deserialized big size.

Exceptions

ArgumentException

Thrown when the stream is empty or insufficient data is available.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

SerializeAsync(Stream)

Serializes a big size to a BinaryWriter.

public Task SerializeAsync(Stream stream)

Parameters

stream Stream

The stream to serialize to.

Returns

Task

Operators

operator ==(BigSize, BigSize)

public static bool operator ==(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool

operator >(BigSize, BigSize)

public static bool operator >(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool

operator >=(BigSize, BigSize)

public static bool operator >=(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool

implicit operator byte(BigSize)

public static implicit operator byte(BigSize bigSize)

Parameters

bigSize BigSize

Returns

byte

implicit operator short(BigSize)

public static implicit operator short(BigSize bigSize)

Parameters

bigSize BigSize

Returns

short

implicit operator int(BigSize)

public static implicit operator int(BigSize bigSize)

Parameters

bigSize BigSize

Returns

int

implicit operator long(BigSize)

public static implicit operator long(BigSize bigSize)

Parameters

bigSize BigSize

Returns

long

implicit operator ushort(BigSize)

public static implicit operator ushort(BigSize bigSize)

Parameters

bigSize BigSize

Returns

ushort

implicit operator uint(BigSize)

public static implicit operator uint(BigSize bigSize)

Parameters

bigSize BigSize

Returns

uint

implicit operator ulong(BigSize)

public static implicit operator ulong(BigSize bigSize)

Parameters

bigSize BigSize

Returns

ulong

implicit operator BigSize(byte)

public static implicit operator BigSize(byte value)

Parameters

value byte

Returns

BigSize

implicit operator BigSize(short)

public static implicit operator BigSize(short value)

Parameters

value short

Returns

BigSize

implicit operator BigSize(int)

public static implicit operator BigSize(int value)

Parameters

value int

Returns

BigSize

implicit operator BigSize(long)

public static implicit operator BigSize(long value)

Parameters

value long

Returns

BigSize

implicit operator BigSize(ushort)

public static implicit operator BigSize(ushort value)

Parameters

value ushort

Returns

BigSize

implicit operator BigSize(uint)

public static implicit operator BigSize(uint value)

Parameters

value uint

Returns

BigSize

implicit operator BigSize(ulong)

public static implicit operator BigSize(ulong value)

Parameters

value ulong

Returns

BigSize

operator !=(BigSize, BigSize)

public static bool operator !=(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool

operator <(BigSize, BigSize)

public static bool operator <(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool

operator <=(BigSize, BigSize)

public static bool operator <=(BigSize left, BigSize right)

Parameters

left BigSize

right BigSize

Returns

bool