JsonString

Namespace: SnowBank.Data.Json · class

Implements: JsonValue, IEquatable<JsonValue>, IComparable<JsonValue>, IJsonSerializable, IFormattable, ISliceSerializable, IConvertible, IParsable<JsonValue>, ISpanParsable<JsonValue>, ISpanFormattable, IUtf8SpanFormattable, INumberBase<JsonValue>, IUtf8SpanParsable<JsonValue>, IAdditionOperators<JsonValue, JsonValue, JsonValue>, IAdditiveIdentity<JsonValue, JsonValue>, IDecrementOperators<JsonValue>, IDivisionOperators<JsonValue, JsonValue, JsonValue>, IEqualityOperators<JsonValue, JsonValue, bool>, IIncrementOperators<JsonValue>, IMultiplicativeIdentity<JsonValue, JsonValue>, IMultiplyOperators<JsonValue, JsonValue, JsonValue>, ISubtractionOperators<JsonValue, JsonValue, JsonValue>, IUnaryNegationOperators<JsonValue, JsonValue>, IUnaryPlusOperators<JsonValue, JsonValue>, IComparisonOperators<JsonValue, JsonValue, bool>, IEquatable<JsonString>, IComparable<JsonString>, IEquatable<string>, IComparable<string>, IEquatable<ReadOnlySpan<char>>, IEquatable<ReadOnlyMemory<char>>, IComparable<ReadOnlySpan<char>>, IComparable<ReadOnlyMemory<char>>, IEquatable<Guid>, IEquatable<Uuid128>, IEquatable<Uuid96>, IEquatable<Uuid80>, IEquatable<Uuid64>, IEquatable<DateTime>, IEquatable<DateTimeOffset>, IEquatable<DateOnly>, IEquatable<TimeOnly>, IEquatable<Instant>, IEquatable<LocalDateTime>, IEquatable<LocalDate>, IEquatable<Uri>, IEquatable<IPAddress>, IEquatable<Version>

JSON string literal

Properties

IsDefault

bool IsDefault { get; }

Tests if this value corresponds to the logical default for this type (0, false, null or missing, ...)

Returns: true for values like 0, false, or null; or false for non-zero integers, true, strings, arrays and objects

The empty string, array and object are NOT considered to be the default value of their type!

JsonNumber.Zero.IsDefault == true, JsonNumber.Return(123).IsDefault == false, JsonString.Return("").IsDefault == false, new JsonArray().IsDefault == false, new JsonObject().IsDefault == false

IsNull

bool IsNull { get; }

Tests if this value is null or missing

IsNullOrEmpty

bool IsNullOrEmpty { get; }

Returns true if the string is empty

IsReadOnly

bool IsReadOnly { get; }

Returns true if this value is read-only, and cannot be modified, or false if it allows mutations.

Only JSON Objects and Arrays can return false. All other "value types" (string, boolean, numbers, ...) are always immutable, and will always be read-only.

If you need to modify a JSON Object or Array that is read-only, you should first create a copy, by calling either Copy or ToMutable, perform any changes required, and then either Freeze the copy, or call ToReadOnly again.

Length

int Length { get; }

Gets the length of the string

Type

JsonType Type { get; }

Type of JSON value (Boolean, String, Number, Object, Array, ...)

Value

string Value { get; }

Gets the string literal

Methods

Bind

T Bind<T>(T defaultValue = null, ICrystalJsonTypeResolver resolver = null)

Bind this value into an instance of type TValue

defaultValue — Default value to return if the current instance is null or missing
resolver — Optional custom resolver used to bind the value into a managed type.

Returns: An instance of the type TValue that is equivalent to the original JSON value, if there exists a valid conversion path. Otherwise, an exception will be thrown.

JsonNumber.Return(123).Bind() will return the value 123.

object Bind(Type type, ICrystalJsonTypeResolver resolver = null)

Bind this value into an instance of the specified type

type — Target managed type
resolver — Optional custom resolver used to bind the value into a managed type.

Returns: An instance of the target type that is equivalent to the original JSON value, if there exists a valid conversion path or convention. Otherwise, an exception will be thrown.

If the target type is a Value Type, the instance will be boxed, which may cause extra memory allocations. Consider calling instance, or use any of the convenience methods like , , ...

JsonNumber.Return(123).Bind(typeof(long)) will return a boxed Int64 with value 123.

CompareTo

int CompareTo(JsonValue other)

Compares two JSON values, and returns an integer that indicates whether the first value precedes, follows, or occurs in the same position in the sort order as the second value.

int CompareTo(JsonString other)

int CompareTo(string other)

int CompareTo(ReadOnlySpan<char> other)

int CompareTo(ReadOnlyMemory<char> other)

Contains

bool Contains(string value)

Tests if the string contains the specified literal

bool Contains(ReadOnlySpan<char> value)

Tests if the string contains the specified literal

bool Contains(ReadOnlyMemory<char> value)

Tests if the string contains the specified literal

bool Contains(JsonString value)

Tests if the string contains the specified literal

bool Contains(JsonValue value)

Tests if the string contains the specified literal

Create

static JsonString Create(string value)

Returns the equivalent JsonString

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

If could be null, call instead, which returns instead of an exception

static JsonString Create(char value)

Returns the equivalent JsonString

value — Character literal

Returns: Equivalent JsonString

static JsonString Create(ReadOnlySpan<char> value)

Returns the equivalent JsonString

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

static JsonString Create(ReadOnlyMemory<char> value)

Returns the equivalent JsonString

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

static JsonString Create(Slice value)

Returns the equivalent JsonString

value — Byte slice literal

Returns: Equivalent JsonString with value encoded as Base64, or the Empty singleton if value is empty

static JsonString Create(ReadOnlySpan<byte> value)

Returns the equivalent JsonString

value — Byte slice literal

Returns: Equivalent JsonString with value encoded as Base64, or the Empty singleton if value is empty

static JsonString Create(Guid value)

Returns the equivalent JsonString

The Empty guid is equivalent to the Empty string, which is a different behavior compared to Return.

static JsonString Create(Uuid128 value)

Returns the equivalent JsonString

The Empty guid is equivalent to the Empty string, which is a different behavior compared to Return.

static JsonString Create(DateTime value)

Returns the equivalent JsonString

static JsonString Create(DateTimeOffset value)

Returns the equivalent JsonString

static JsonString Create(DateOnly value)

Returns the equivalent JsonString

static JsonString Create(TimeOnly value)

Returns the equivalent JsonString

static JsonString Create(Instant value)

Returns the equivalent JsonString

EndsWith

bool EndsWith(string value)

Tests if the string ends with the specified literal

bool EndsWith(ReadOnlySpan<char> value)

Tests if the string ends with the specified literal

bool EndsWith(ReadOnlyMemory<char> value)

Tests if the string ends with the specified literal

bool EndsWith(JsonString value)

Tests if the string ends with the specified literal

bool EndsWith(JsonValue value)

Tests if the string ends with the specified literal

Equals

bool Equals(object obj)

bool Equals(JsonValue other)

Tests if these two JSON values are considered equal, using the relaxed JSON comparison semantics

Two values are considered "equal" if they would produce the same result when serialized using a canonical representation.

Numbers are equal if they represent the "same" number (ie: 1 and 1.0 are equal)

Numbers and strings can be equal, if the later can be parsed into a number equal to the former (ie: 123 and "123" are equal)

Arrays are equal if they have the same length and all their elements are equals pairwise

Objects are equal if they have the same key/value pairs, irrespective of their order.

A Missing field is not considered equal to an explicit Null field, and vice versa

If you require strict equality (ie: "123" and 123 are different), consider calling StrictEquals instead.

bool Equals(JsonString other)

bool Equals(string other)

bool Equals(ReadOnlySpan<char> other)

bool Equals(ReadOnlyMemory<char> other)

bool Equals(Guid other)

bool Equals(Uuid128 other)

bool Equals(Uuid96 other)

bool Equals(Uuid80 other)

bool Equals(Uuid64 other)

bool Equals(DateTime other)

bool Equals(DateTimeOffset other)

bool Equals(DateOnly other)

bool Equals(TimeOnly other)

bool Equals(Instant other)

bool Equals(LocalDateTime other)

bool Equals(LocalDate other)

bool Equals(IPAddress other)

bool Equals(Uri other)

bool Equals(Version other)

GetHashCode

int GetHashCode()

Returns a hash code that can be used to quickly identify a JSON value.

The hash code is guaranteed to remain unchanged during the lifetime of the object.

Caution: there is NO guarantee that two equivalent Objects or Arrays will have the same hash code! This means that it is NOT safe to use a JSON object or array has the key of a Dictionary or other collection that uses hash codes to quickly compare two instances.

IndexOf

int IndexOf(string value)

Returns the index of the first occurrence of the specified literal

Returns -1 if the string does not contain this literal

int IndexOf(ReadOnlySpan<char> value)

Returns the index of the first occurrence of the specified literal

Returns -1 if the string does not contain this literal

int IndexOf(ReadOnlyMemory<char> value)

Returns the index of the first occurrence of the specified literal

Returns -1 if the string does not contain this literal

int IndexOf(JsonString value)

Returns the index of the first occurrence of the specified literal

Returns -1 if the string does not contain this literal

int IndexOf(JsonValue value)

Returns the index of the first occurrence of the specified literal

Returns -1 if the string does not contain this literal

JsonSerialize

void JsonSerialize(CrystalJsonWriter writer)

Serializes this instance as JSON

writer — Writer that will output the content of this instance

Return

static JsonValue Return(string value)

Returns a JsonValue that is equivalent to the specified string literal

value — String literal, or null

Returns: Equivalent JsonString, the Empty singleton if value is empty, or the Null singleton if value is null

static JsonValue Return(ReadOnlySpan<char> value)

Returns a JsonValue that is equivalent to the span of characters

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

static JsonValue Return(ReadOnlyMemory<char> value)

Returns a JsonValue that is equivalent to the span of characters

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

static JsonValue Return(StringBuilder value)

Returns a JsonValue that is equivalent to the content of the specified StringBuilder

value — String literal

Returns: Equivalent JsonString, or the Empty singleton if value is empty

static JsonValue Return(char value)

Returns a JsonValue that is equivalent to the specified character

value — Character literal

Returns: Equivalent JsonString

Please note that if is equal to 0, this method will return the "\x00" string

static JsonValue Return(char? value)

Returns a JsonValue that is equivalent to the specified character

value — Character literal, or null

Returns: Equivalent JsonString, or the Null singleton if value is null

Please note that if is equal to 0, this method will return the "\x00" string

static JsonValue Return(byte[] value)

Returns the equivalent JsonString

static JsonValue Return(Slice value)

Returns the equivalent JsonString

static JsonValue Return(ReadOnlySpan<byte> value)

Returns the equivalent JsonString

static JsonValue Return(ReadOnlyMemory<byte> value)

Returns the equivalent JsonString

static JsonValue Return(ArraySegment<byte> value)

Returns the equivalent JsonString

static JsonValue Return(Guid value)

Returns the equivalent JsonString

The Empty guid is equivalent to a Null entry

static JsonValue Return(Guid? value)

Returns the equivalent JsonString

The Empty guid is equivalent to a Null entry

static JsonValue Return(Uuid128 value)

Returns the equivalent JsonString