JsonBoolean
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<bool>, IEquatable<JsonBoolean>, IComparable<JsonBoolean>
JSON Boolean (true or false)
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
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.
Type
JsonType Type { get; }
Type of JSON value (Boolean, String, Number, Object, Array, ...)
Value
bool Value { get; }
Methods
Bind
TValue Bind<TValue>(TValue 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 missingresolver— 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
object Bind(Type type, ICrystalJsonTypeResolver resolver = null)
Bind this value into an instance of the specified type
type— Target managed typeresolver— 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(JsonBoolean other)
Create
static JsonBoolean Create(bool value)
Equals
bool Equals(object value)
bool Equals(JsonValue value)
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(JsonBoolean obj)
bool Equals(bool value)
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.
JsonSerialize
void JsonSerialize(CrystalJsonWriter writer)
Serializes this instance as JSON
writer— Writer that will output the content of this instance
Return
static JsonValue Return(bool value)
static JsonValue Return(bool? value)
Returns either True, False or Null
StrictEquals
bool StrictEquals(JsonValue other)
Tests if these two JSON values are considered equal, using the strict JSON comparison semantics
For two values to be considered "equal", they must be of the same type (string, number, array, ...) AND have the same result when serialized using a canonical representation.
Arrays are equals if they have the same length and all their elements are also strictly equal.
Objects are equal if they have the same keys, irrespective of their order, and each value is strictly equal.
A Missing field is not considered equal to an explicit Null field, and vice versa
bool StrictEquals(JsonBoolean other)
ToBoolean
bool ToBoolean(bool _ = false)
Returns the equivalent Boolean, if there exists a valid conversion
ToByte
byte ToByte(byte _ = 0)
Returns the equivalent Byte, if there exists a valid conversion
ToChar
char ToChar(char _ = '�')
Returns the equivalent Char, if there exists a valid conversion
ToDecimal
decimal ToDecimal(decimal _ = 0)
Returns the equivalent Decimal, if there exists a valid conversion
ToDouble
double ToDouble(double _ = 0)
Returns the equivalent Double, if there exists a valid conversion
ToGuid
Guid ToGuid(Guid _ = null)
Returns the equivalent Guid, if there exists a valid conversion
ToHalf
Half ToHalf(Half _ = null)
Returns the equivalent Half, if there exists a valid conversion
ToInt128
Int128 ToInt128(Int128 _ = null)
Returns the equivalent Int128, if there exists a valid conversion
ToInt16
short ToInt16(short _ = 0)
Returns the equivalent Int16, if there exists a valid conversion
ToInt32
int ToInt32(int _ = 0)
Returns the equivalent Int32, if there exists a valid conversion
ToInt64
long ToInt64(long _ = 0)
Returns the equivalent Int64, if there exists a valid conversion
ToJsonText
string ToJsonText(CrystalJsonSettings settings = null, ICrystalJsonTypeResolver resolver = null)
Serializes this JSON value into a JSON string literal
settings— Settings used to change the serialized JSON output (optional)resolver— Optional custom resolver.
Returns: JSON text literal that can be written to disk, returned as the body of an HTTP request, or
var jsonText = new JsonObject() { ["hello"] = "world" }.ToJsonText(); // == "{ "hello": "world" }"
ToObject
object ToObject()
Converts this into a CLR object (with a type that matches the value)
Prefer casting to a specific type, using As
ToSByte
sbyte ToSByte(sbyte _ = 0)
Returns the equivalent SByte, if there exists a valid conversion
ToSingle
float ToSingle(float _ = 0)
Returns the equivalent Single, if there exists a valid conversion
ToString
string ToString()
Converts this JSON value into a printable string
Please note that, due to convention in .NET, this will return the empty string for null values, since ToString must not return a null reference! Please call ToStringOrDefault if you need null references for null or missing JSON values.
See ToString if you need to specify a different format than the default
ToUInt128
UInt128 ToUInt128(UInt128 _ = null)
Returns the equivalent UInt128, if there exists a valid conversion
ToUInt16
ushort ToUInt16(ushort _ = 0)
Returns the equivalent UInt16, if there exists a valid conversion
ToUInt32
uint ToUInt32(uint _ = 0)
Returns the equivalent UInt32, if there exists a valid conversion
ToUInt64
ulong ToUInt64(ulong _ = 0)
Returns the equivalent UInt64, if there exists a valid conversion
ToUuid48
Uuid48 ToUuid48(Uuid48 _ = null)
Returns the equivalent Uuid48, if there exists a valid conversion
ToUuid64
Uuid64 ToUuid64(Uuid64 _ = null)
Returns the equivalent Uuid64, if there exists a valid conversion
ToUuid80
Uuid80 ToUuid80(Uuid80 _ = null)
Returns the equivalent Uuid80, if there exists a valid conversion
ToUuid96
Uuid96 ToUuid96(Uuid96 _ = null)
Returns the equivalent Uuid96, if there exists a valid conversion
TryFormat
bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = null, IFormatProvider provider = null)
bool TryFormat(Span<byte> destination, out int bytesWritten, ReadOnlySpan<char> format = null, IFormatProvider provider = null)
ValueEquals
bool ValueEquals<TValue>(TValue value, IEqualityComparer<TValue> comparer = null)
Tests if the current instance is equal to the specified value, using the strict JSON comparison semantics
value— Value to test with the current instancecomparer— Custom equality comparer if specified; otherwise, uses the default comparer for this type
Returns: true if both arguments are considered equal; otherwise, false
This method tries to perform an optimized comparison, and should perform less memory allocations than calling
WriteTo
void WriteTo(ref SliceWriter writer)
Serializes the current instance to the specified output buffer
Fields
False
static readonly JsonBoolean False
JSON value that is equal to false
This singleton is immutable and can be cached
True
static readonly JsonBoolean True
JSON value that is equal to true
This singleton is immutable and can be cached