PstNodeInfo Class

Definition

Namespace

Bodu.IO.Pst

Assembly

Bodu.IO.Pst.dll

Package

Bodu.IO.Pst 0.7.1

Source

PstNodeInfo.cs

Provides an immutable snapshot of a node's directory facts: its identifier, its parent, the size of its data payload, and whether it carries a subnode tree.

public sealed record PstNodeInfo : IEquatable<PstNodeInfo>

Inheritance

object

PstNodeInfo

Implements

IEquatable<PstNodeInfo>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Constructors

PstNodeInfo(PstNodeId, PstNodeId, long, bool)

Provides an immutable snapshot of a node's directory facts: its identifier, its parent, the size of its data payload, and whether it carries a subnode tree.

public PstNodeInfo(PstNodeId NodeId, PstNodeId ParentNodeId, long DataLength, bool HasSubnodes)

Parameters

NodeId PstNodeId

The node identifier.

ParentNodeId PstNodeId

The parent node identifier the node database records, or the zero identifier when none is recorded. For a subnode, this is the owning node's identifier.

DataLength long

The total data payload length in bytes; 0 when the node carries no data.

HasSubnodes bool

Whether the node carries a subnode tree.

Properties

DataLength

The total data payload length in bytes; 0 when the node carries no data.

public long DataLength { get; init; }

Property Value

long

HasSubnodes

Whether the node carries a subnode tree.

public bool HasSubnodes { get; init; }

Property Value

bool

NodeId

The node identifier.

public PstNodeId NodeId { get; init; }

Property Value

PstNodeId

ParentNodeId

The parent node identifier the node database records, or the zero identifier when none is recorded. For a subnode, this is the owning node's identifier.

public PstNodeId ParentNodeId { get; init; }

Property Value

PstNodeId

Methods

Deconstruct(out PstNodeId, out PstNodeId, out long, out bool)

public void Deconstruct(out PstNodeId NodeId, out PstNodeId ParentNodeId, out long DataLength, out bool HasSubnodes)

Parameters

NodeId PstNodeId

ParentNodeId PstNodeId

DataLength long

HasSubnodes bool

Equals(PstNodeInfo?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(PstNodeInfo? other)

Parameters

other PstNodeInfo

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

operator ==(PstNodeInfo?, PstNodeInfo?)

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

Parameters

left PstNodeInfo

right PstNodeInfo

Returns

bool

operator !=(PstNodeInfo?, PstNodeInfo?)

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

Parameters

left PstNodeInfo

right PstNodeInfo

Returns

bool

Applies to

Product	Versions
.NET	8, 10