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
Methods
Append(HierarchicalKey)Composes this hierarchy with an already constructed suffix hierarchy.Create(ReadOnlySpan<string>)Creates a hierarchy from literal segments in root-first order.Create(string)Creates one literal segment, escaping slash and backslash characters.CreateChildKey(string)Appends one literal child segment.Equals(HierarchicalKey)Indicates whether the current object is equal to another object of the same type.Equals(object?)Indicates whether this instance and a specified object are equal.GetEnumeratorEnumerates escaped canonical segment spans in root-first order.GetHashCodeReturns the hash code for this instance.GetParentGets the immediate parent, or null for a root or unset key.IsAncestorOf(HierarchicalKey)Tests whether this key is equal to or an ancestor of the other key.IsChildOf(HierarchicalKey)Tests whether this key is the other's immediate child.IsParentOf(HierarchicalKey)Tests whether this key is the other's immediate parent.Parse(ReadOnlySpan<char>, IFormatProvider?)Parses a span of characters into a value.Parse(string, IFormatProvider?)Parses a string into a value.ToStringReturns the fully qualified type name of this instance.ToString(string?, IFormatProvider?)Formats the value of the current instance using the specified format.TryFormat(Span<char>, int, ReadOnlySpan<char>, IFormatProvider?)Tries to format the value of the current instance into the provided span of characters.TryParse(ReadOnlySpan<char>, IFormatProvider?, HierarchicalKey)Tries to parse a span of characters into a value.TryParse(string?, IFormatProvider?, HierarchicalKey)Tries to parse a string into a value.operator ==(HierarchicalKey, HierarchicalKey)Compares complete ordinal key values.operator !=(HierarchicalKey, HierarchicalKey)Compares complete ordinal key values for inequality.
Fields
EscapeCharacterThe escape character used within canonical segments.SegmentSeparatorThe separator between canonical segments.
