RelativeJsonPointer Struct

Namespace: Json.Pointer

Inheritance: RelativeJsonPointer 🡒 ValueType 🡒 object

Implemented interfaces:

• IEquatable<RelativeJsonPointer>

Represents a Relative JSON Pointer IAW draft-handrews-relative-json-pointer-02

Fields

Name	Type	Summary
Null	RelativeJsonPointer	The null pointer. Indicates no navigation should occur.

Properties

Name	Type	Summary
ArrayIndexManipulator	int	Gets the number of lateral steps to take. Applicable only for arrays.
IsIndexQuery	bool	Gets whether the pointer is an index query, which returns the index within the parent rather than the value.
ParentSteps	uint	Gets the number of parent (root) steps to take.
Pointer	JsonPointer	Gets the pointer to follow after taking Json.Pointer.RelativeJsonPointer.ParentSteps steps upward.

Constructors

RelativeJsonPointer()

Creates the null pointer.

Declaration

public RelativeJsonPointer()

Methods

Equals(RelativeJsonPointer other)

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

Declaration

public bool Equals(RelativeJsonPointer other)

Parameter	Type	Description
other	RelativeJsonPointer	An object to compare with this object.

Returns

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

Equals(object obj)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object obj)

Parameter	Type	Description
obj	object	The object to compare with the current instance.

Returns

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

FromPointer(uint parentSteps, JsonPointer pointer)

Creates a Relative JSON Pointer from a JSON Pointer and a number of parent steps.

Declaration

public static RelativeJsonPointer FromPointer(uint parentSteps, JsonPointer pointer)

Parameter	Type	Description
parentSteps	uint	The number of parent steps.
pointer	JsonPointer	The JSON Pointer.

Returns

A Relative JSON Pointer.

FromPointer(uint parentSteps, int arrayIndexManipulator, JsonPointer pointer)

Creates a Relative JSON Pointer from a JSON Pointer and a number of parent steps.

Declaration

public static RelativeJsonPointer FromPointer(uint parentSteps, int arrayIndexManipulator, JsonPointer pointer)

Parameter	Type	Description
parentSteps	uint	The number of parent steps.
arrayIndexManipulator	int	The index manipulator.
pointer	JsonPointer	The JSON Pointer.

Returns

A Relative JSON Pointer.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

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

IndexQuery(uint parentSteps)

Creates an index query pointer.

Declaration

public static RelativeJsonPointer IndexQuery(uint parentSteps)

Parameter	Type	Description
parentSteps	uint

Returns

A Relative JSON Pointer.

IndexQuery(uint parentSteps, int arrayIndexManipulator)

Creates an index query pointer.

Declaration

public static RelativeJsonPointer IndexQuery(uint parentSteps, int arrayIndexManipulator)

Parameter	Type	Description
parentSteps	uint
arrayIndexManipulator	int	The index manipulator.

Returns

A Relative JSON Pointer.

Parse(string source)

Parses a JSON Pointer segment from a string.

Declaration

public static RelativeJsonPointer Parse(string source)

Parameter	Type	Description
source	string	The source string.

Returns

A Relative JSON Pointer.

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override string ToString()

Returns

The fully qualified type name.

TryEvaluate(JsonNode node, out JsonNode result)

Evaluates the relative pointerOld over a System.Text.Json.Nodes.JsonNode.

Declaration

public bool TryEvaluate(JsonNode node, out JsonNode result)

Parameter	Type	Description
node	JsonNode	The System.Text.Json.Nodes.JsonNode.
result	out JsonNode	The result, if return value is true; null otherwise

Returns

true if a value exists at the indicate path; false otherwise.

TryParse(string source, out RelativeJsonPointer relativePointer)

Parses a JSON PointerOld from a string.

Declaration

public static bool TryParse(string source, out RelativeJsonPointer relativePointer)

Parameter	Type	Description
source	string	The source string.
relativePointer	out RelativeJsonPointer	The resulting relative pointerOld.

Returns

true if the parse was successful; false otherwise.