Skip to content

HierarchicalKey

struct

Namespace: Orleans.Durable.Messaging

An immutable, ordinal application identity formed from nonempty hierarchical segments.
[Orleans.Immutable]
[Orleans.Alias(Orleans.Durable.Messaging.HierarchicalKey)]
[System.Text.Json.Serialization.JsonConverter(Orleans.Durable.Messaging.HierarchicalKey.HierarchicalKeyJsonConverter)]
public readonly struct HierarchicalKey : IEquatable<HierarchicalKey>, IFormattable, IParsable<HierarchicalKey>, ISpanFormattable, ISpanParsable<HierarchicalKey>

Remarks

Create constructs literal segments and escapes slash and backslash characters exactly once. Parse reads the canonical escaped path. The key wraps its canonical string; equality and hashing use that string. Applications preserve the identity across retries. Every key is well-formed UTF-16: surrogate characters appear only as high-low pairs, so distinct keys keep distinct serialized forms.

Properties

  • IsDefaultGets whether this value is unset.
  • LengthGets the canonical path length in UTF-16 characters.

Methods

Fields