All types|All members

Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Sealed class: RT.Json.JsonNoValue

Summary

Represents a non-value when looking up a non-existent index or key in a list or dictionary.

Remarks

  • This is a singleton class; use JsonNoValue.Instance to access it.
  • This class overloads the == operator such that comparing with null returns true.

Instance methods

void
Add(JsonValue item)
 Add the specified item to the current list if it is a JsonList; otherwise, throws.
void
Add(string key, JsonValue value)
 Adds the specified key/value pair to the dictionary if this is a JsonDict; otherwise, throws.
void
AddRange(IEnumerable<KeyValuePair<string, JsonValue>> items)
 Add the specified items to the current dictionary if it is a JsonDict; otherwise, throws.
void
AddRange(IEnumerable<JsonValue> items)
 Add the specified items to the current list if it is a JsonList; otherwise, throws.
void
AppendIndented(StringBuilder sb, int indentation = 0)
Converts the current JSON value to a JSON string that parses back to this value.
void
Clear()
 Removes all items from the current value if it is a JsonList or JsonDict; otherwise, throws.
bool
Contains(JsonValue item)
 Determines whether the specified item is contained in the current list if it is a JsonList; otherwise, throws.
bool
ContainsKey(string key)
 Determines whether an entry with the specified key exists in the dictionary if this is a JsonDict; otherwise, throws.
void
CopyTo(JsonValue[] array, int arrayIndex)
 Copies the entire list to a compatible one-dimensional array, starting at the specified arrayIndex of the target array, if this is a JsonList; otherwise, throws.
bool
Equals(object other)
  • Overrides: object.Equals(object)
See JsonValue.Equals(JsonValue).
bool
Equals(JsonValue other)
bool
Equals(JsonNoValue other)
bool
GetBool(BoolConversionOptions options = BoolConversionOptions.Strict)
Converts the current value to a bool. Throws if the conversion is not valid.
bool
GetBoolLenient()
 Converts the current value to a bool by using the BoolConversionOptions.Lenient option. Throws if the conversion is not valid.
bool?
GetBoolLenientSafe()
 Converts the current value to a bool by using the BoolConversionOptions.Lenient option. Returns null if the conversion is not valid.
bool?
GetBoolSafe(BoolConversionOptions options = BoolConversionOptions.Strict)
Converts the current value to a bool. Returns null if the conversion is not valid.
decimal
GetDecimal(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a decimal. Throws if the conversion is not valid.
decimal
GetDecimalLenient()
 Converts the current value to a decimal by using the NumericConversionOptions.Lenient option. Throws if the conversion is not valid.
decimal?
GetDecimalLenientSafe()
 Converts the current value to a decimal by using the NumericConversionOptions.Lenient option. Returns null if the conversion is not valid.
decimal?
GetDecimalSafe(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a decimal. Returns null if the conversion is not valid.
JsonDict
GetDict()
 Converts the current value to JsonDict if it is a JsonDict; otherwise, throws.
JsonDict
GetDictSafe()
 Converts the current value to JsonDict if it is a JsonDict; otherwise, returns null.
double
GetDouble(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a double. Throws if the conversion is not valid.
double
GetDoubleLenient()
 Converts the current value to a double by using the NumericConversionOptions.Lenient option. Throws if the conversion is not valid.
double?
GetDoubleLenientSafe()
 Converts the current value to a double by using the NumericConversionOptions.Lenient option. Returns null if the conversion is not valid.
double?
GetDoubleSafe(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a double. Returns null if the conversion is not valid.
int
GetHashCode()
  • Overrides: object.GetHashCode()
Returns a hash code representing this object.
int
GetInt(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to an int. Throws if the conversion is not valid.
int
GetIntLenient()
 Converts the current value to an int by using the NumericConversionOptions.Lenient option. Throws if the conversion is not valid.
int?
GetIntLenientSafe()
 Converts the current value to an int by using the NumericConversionOptions.Lenient option. Returns null if the conversion is not valid.
int?
GetIntSafe(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to an int. Returns null if the conversion is not valid.
JsonList
GetList()
 Converts the current value to JsonList if it is a JsonList; otherwise, throws.
JsonList
GetListSafe()
 Converts the current value to JsonList if it is a JsonList; otherwise, returns null.
long
GetLong(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a long. Throws if the conversion is not valid.
long
GetLongLenient()
 Converts the current value to a long by using the NumericConversionOptions.Lenient option. Throws if the conversion is not valid.
long?
GetLongLenientSafe()
 Converts the current value to a long by using the NumericConversionOptions.Lenient option. Returns null if the conversion is not valid.
long?
GetLongSafe(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a long. Returns null if the conversion is not valid.
string
GetString(StringConversionOptions options = StringConversionOptions.Strict)
Converts the current value to a string. Throws if the conversion is not valid.
string
GetStringLenient()
 Converts the current value to a string by using the StringConversionOptions.Lenient option. Throws if the conversion is not valid.
string
GetStringLenientSafe()
 Converts the current value to a string by using the StringConversionOptions.Lenient option. Returns null if the conversion is not valid.
string
GetStringSafe(StringConversionOptions options = StringConversionOptions.Strict)
Converts the current value to a string. Returns null if the conversion is not valid.
ulong
GetULong(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a ulong. Throws if the conversion is not valid.
ulong
GetULongLenient()
 Converts the current value to a ulong by using the NumericConversionOptions.Lenient option. Throws if the conversion is not valid.
ulong?
GetULongLenientSafe()
 Converts the current value to a ulong by using the NumericConversionOptions.Lenient option. Returns null if the conversion is not valid.
ulong?
GetULongSafe(NumericConversionOptions options = NumericConversionOptions.Strict)
Converts the current value to a ulong. Returns null if the conversion is not valid.
int
IndexOf(JsonValue item)
 Returns the index of the first occurrence of the specified item within the current list if it is a JsonList; otherwise, throws.
void
Insert(int index, JsonValue item)
 Inserts the specified item at the specified index to the current list if it is a JsonList; otherwise, throws.
bool
Remove(string key)
 Removes the entry with the specified key from the dictionary if this is a JsonDict; otherwise, throws.
bool
Remove(JsonValue item)
 Removes the first instance of the specified item from the current list if it is a JsonList; otherwise, throws.
void
RemoveAt(int index)
 Removes the item at the specified index from the current list if it is a JsonList; otherwise, throws.
IEnumerable<string>
ToEnumerable()
See JsonValue.ToEnumerable().
string
ToString()
  • Inherited from JsonValue
  • Overrides: object.ToString()
Converts the current JSON value to a JSON string that parses back to this value.
string
ToStringIndented()
bool
TryGetValue(string key, out JsonValue value)
 Attempts to retrieve the value associated with the specified key if this is a JsonDict; otherwise, throws.

Static methods

void
AppendIndented(JsonValue value, StringBuilder sb, int indentation = 0)
 Converts the JSON value to a JSON string that parses back to this value and places the string into the specified StringBuilder. Supports null values.
string
Fmt(string js, params JsonValue[] namevalues)
 Formats JSON values into a piece of JavaScript code and then removes almost all unnecessary whitespace and comments. Values are referenced by names; placeholders for these values are written as {{name}}. Placeholders are only replaced outside of JavaScript literal strings and regexes. JsonRaw instances are inserted unmodified.
JsonValue
Parse(string jsonValue, bool allowJavaScript = false)
 Parses the specified string into a JSON value.
IEnumerable<string>
ToEnumerable(JsonValue value)
Lazy-converts the JSON value to a JSON string that parses back to this value. Supports null values.
string
ToString(JsonValue value)
Converts the JSON value to a JSON string that parses back to this value. Supports null values.
string
ToStringIndented(JsonValue value)
bool
TryParse(string jsonValue, out JsonValue result)
 Attempts to parse the specified string into a JSON value.

Operators

bool
operator==(JsonNoValue one, JsonNoValue two)
 Always returns true. (see also remarks)
string
explicit operator string(JsonValue value)
See StringConversionOptions.Strict.
bool
explicit operator bool(JsonValue value)
See BoolConversionOptions.Strict.
bool?
explicit operator bool?(JsonValue value)
double
explicit operator double(JsonValue value)
See NumericConversionOptions.Strict.
double?
explicit operator double?(JsonValue value)
decimal
explicit operator decimal(JsonValue value)
decimal?
explicit operator decimal?(JsonValue value)
long
explicit operator long(JsonValue value)
long?
explicit operator long?(JsonValue value)
ulong
explicit operator ulong(JsonValue value)
ulong?
explicit operator ulong?(JsonValue value)
int
explicit operator int(JsonValue value)
int?
explicit operator int?(JsonValue value)
string[]
explicit operator string[](JsonValue values)
See StringConversionOptions.Strict.
bool[]
explicit operator bool[](JsonValue values)
See BoolConversionOptions.Strict.
bool?[]
explicit operator bool?[](JsonValue values)
double[]
explicit operator double[](JsonValue values)
See NumericConversionOptions.Strict.
double?[]
explicit operator double?[](JsonValue values)
decimal[]
explicit operator decimal[](JsonValue values)
decimal?[]
explicit operator decimal?[](JsonValue values)
long[]
explicit operator long[](JsonValue values)
long?[]
explicit operator long?[](JsonValue values)
ulong[]
explicit operator ulong[](JsonValue values)
ulong?[]
explicit operator ulong?[](JsonValue values)
int[]
explicit operator int[](JsonValue values)
int?[]
explicit operator int?[](JsonValue values)
List<string>
explicit operator List<string>(JsonValue values)
See StringConversionOptions.Strict.
List<bool>
explicit operator List<bool>(JsonValue values)
See BoolConversionOptions.Strict.
List<bool?>
explicit operator List<bool?>(JsonValue values)
List<double>
explicit operator List<double>(JsonValue values)
See NumericConversionOptions.Strict.
List<double?>
explicit operator List<double?>(JsonValue values)
List<decimal>
explicit operator List<decimal>(JsonValue values)
List<decimal?>
explicit operator List<decimal?>(JsonValue values)
List<long>
explicit operator List<long>(JsonValue values)
List<long?>
explicit operator List<long?>(JsonValue values)
List<ulong>
explicit operator List<ulong>(JsonValue values)
List<ulong?>
explicit operator List<ulong?>(JsonValue values)
List<int>
explicit operator List<int>(JsonValue values)
List<int?>
explicit operator List<int?>(JsonValue values)
JsonValue
implicit operator JsonValue(string value)
Constructs a JsonValue from the specified string.
JsonValue
implicit operator JsonValue(bool value)
Constructs a JsonValue from the specified boolean.
JsonValue
implicit operator JsonValue(bool? value)
Constructs a JsonValue from the specified nullable boolean.
JsonValue
implicit operator JsonValue(double value)
Constructs a JsonValue from the specified double.
JsonValue
implicit operator JsonValue(double? value)
Constructs a JsonValue from the specified nullable double.
JsonValue
implicit operator JsonValue(decimal value)
Constructs a JsonValue from the specified decimal.
JsonValue
implicit operator JsonValue(decimal? value)
Constructs a JsonValue from the specified nullable decimal.
JsonValue
implicit operator JsonValue(long value)
Constructs a JsonValue from the specified long.
JsonValue
implicit operator JsonValue(long? value)
Constructs a JsonValue from the specified nullable long.
JsonValue
implicit operator JsonValue(ulong value)
Constructs a JsonValue from the specified ulong.
JsonValue
implicit operator JsonValue(ulong? value)
Constructs a JsonValue from the specified nullable ulong.
JsonValue
implicit operator JsonValue(int value)
Constructs a JsonValue from the specified int.
JsonValue
implicit operator JsonValue(int? value)
Constructs a JsonValue from the specified nullable int.
JsonValue
implicit operator JsonValue(string[] values)
Constructs a JsonValue from the specified array.
JsonValue
implicit operator JsonValue(bool[] values)
JsonValue
implicit operator JsonValue(bool?[] values)
JsonValue
implicit operator JsonValue(double[] values)
JsonValue
implicit operator JsonValue(double?[] values)
JsonValue
implicit operator JsonValue(decimal[] values)
JsonValue
implicit operator JsonValue(decimal?[] values)
JsonValue
implicit operator JsonValue(long[] values)
JsonValue
implicit operator JsonValue(long?[] values)
JsonValue
implicit operator JsonValue(ulong[] values)
JsonValue
implicit operator JsonValue(ulong?[] values)
JsonValue
implicit operator JsonValue(int[] values)
JsonValue
implicit operator JsonValue(int?[] values)
JsonValue
implicit operator JsonValue(JsonValue[] values)
JsonValue
implicit operator JsonValue(List<string> values)
Constructs a JsonValue from the specified list.
JsonValue
implicit operator JsonValue(List<bool> values)
JsonValue
implicit operator JsonValue(List<bool?> values)
JsonValue
implicit operator JsonValue(List<double> values)
JsonValue
implicit operator JsonValue(List<double?> values)
JsonValue
implicit operator JsonValue(List<decimal> values)
JsonValue
implicit operator JsonValue(List<decimal?> values)
JsonValue
implicit operator JsonValue(List<long> values)
JsonValue
implicit operator JsonValue(List<long?> values)
JsonValue
implicit operator JsonValue(List<ulong> values)
JsonValue
implicit operator JsonValue(List<ulong?> values)
JsonValue
implicit operator JsonValue(List<int> values)
JsonValue
implicit operator JsonValue(List<int?> values)
JsonValue
implicit operator JsonValue(List<JsonValue> values)
bool
operator!=(JsonNoValue one, JsonNoValue two)
 Always returns false.

Instance properties

int
Count
 Returns the number of items in the current value if it is a JsonList or JsonDict; otherwise, throws.
bool
IsContainer
 Returns true if this value is a JsonDict or a JsonList; otherwise, returns false.
JsonValue
this[int index]
 Returns the item at the specified index within the current list if it is a JsonList; otherwise, throws.
JsonValue
this[string key]
 Gets or sets the value associated with the specified key if this value is a JsonDict; otherwise, throws.
ICollection<string>
Keys
Returns the keys contained in the dictionary if this is a JsonDict; otherwise, throws.
JsonSafeValue
Safe
 Returns an object that allows safe access to the indexers. “Safe” in this context means that the indexers, when given an index or key not found in the list or dictionary, do not throw but instead return JsonNoValue.Instance whose getters (such as JsonValue.GetString(StringConversionOptions)) return null.
ICollection<JsonValue>
Values
Returns the values contained in the dictionary if this is a JsonDict; otherwise, throws.

Static properties

JsonNoValue
Instance
Returns the singleton instance of this type.