Struct tidb_query_datatype::codec::mysql::json::JsonRef

pub struct JsonRef<'a> {
    type_code: JsonType,
    value: &'a [u8],
}

Represents a reference of JSON value aiming to reduce memory copy.

Fields

type_code: JsonType

value: &'a [u8]

Implementations

impl<'a> JsonRef<'a>

pub fn array_get_elem(&self, idx: usize) -> Result<JsonRef<'a>>

Gets the ith element in JsonRef

See arrayGetElem() in TiDB json/binary.go

pub fn object_get_key(&self, i: usize) -> &'a [u8]

Return the ith key in current Object json

See arrayGetElem() in TiDB json/binary.go

pub fn object_get_val(&self, i: usize) -> Result<JsonRef<'a>>

Returns the JsonRef of ith value in current Object json

See arrayGetElem() in TiDB json/binary.go

pub fn object_search_key(&self, key: &[u8]) -> Option<usize>

Searches the value index by the give key in Object.

See objectSearchKey() in TiDB json/binary_function.go

pub fn val_entry_get(&self, val_entry_off: usize) -> Result<JsonRef<'a>>

Gets the value (JsonRef) by the given offset of the value entry

See arrayGetElem() in TiDB json/binary.go

pub(super) fn as_ptr(&self) -> *const u8

Returns a raw pointer to the underlying values buffer.

pub(super) fn as_literal(&self) -> Result<u8>

Returns the literal value of JSON document

pub fn binary_len(&self) -> usize

Returns the encoding binary length of self

impl<'a> JsonRef<'a>

fn get_precedence(&self) -> i32

fn as_f64(&self) -> Result<f64>

impl<'a> JsonRef<'a>

fn encoded_len(&self) -> usize

impl<'a> JsonRef<'a>

pub fn depth(&self) -> Result<i64>

Returns maximum depth of JSON document

impl<'a> JsonRef<'a>

pub fn extract(&self, path_expr_list: &[PathExpression]) -> Result<Option<Json>>

extract receives several path expressions as arguments, matches them in j, and returns the target JSON matched any path expressions, which may be autowrapped as an array. If there is no any expression matched, it returns None.

See Extract() in TiDB json.binary_function.go

impl<'a> JsonRef<'a>

pub fn keys(&self, path_expr_list: &[PathExpression]) -> Result<Option<Json>>

Evaluates a (possibly empty) list of values and returns a JSON array containing those values specified by path_expr_list

impl<'a> JsonRef<'a>

fn len(&self) -> i64

pub fn json_length(
    &self,
    path_expr_list: &[PathExpression]
) -> Result<Option<i64>>

json_length is the implementation for JSON_LENGTH in mysql https://dev.mysql.com/doc/refman/5.7/en/json-attribute-functions.html#function_json-length

impl<'a> JsonRef<'a>

pub fn modify(
    &self,
    path_expr_list: &[PathExpression],
    values: Vec<Json>,
    mt: ModifyType
) -> Result<Json>

Modifies a Json object by insert, replace or set. All path expressions cannot contain * or ** wildcard. If any error occurs, the input won’t be changed.

See Modify() in TiDB json/binary_function.go

impl<'a> JsonRef<'a>

pub fn remove(&self, path_expr_list: &[PathExpression]) -> Result<Json>

Removes elements from Json, All path expressions cannot contain * or ** wildcard. If any error occurs, the input won’t be changed.

impl<'a> JsonRef<'a>

pub fn json_type(&self) -> &'static [u8]

json_type is the implementation for https://dev.mysql.com/doc/refman/5.7/en/json-attribute-functions.html#function_json-type

impl<'a> JsonRef<'a>

pub fn unquote(&self) -> Result<String>

unquote recognizes the escape sequences shown in: https://dev.mysql.com/doc/refman/5.7/en/json-modification-functions.html json-unquote-character-escape-sequences

See Unquote() in TiDB json/binary_function.go

impl<'a> JsonRef<'a>

pub fn new(type_code: JsonType, value: &[u8]) -> JsonRef<'_>

pub fn to_owned(&self) -> Json

Returns an owned Json via copying

pub fn get_type(&self) -> JsonType

Returns the JSON type

pub fn value(&self) -> &'a [u8]

Returns the underlying value slice

pub(crate) fn get_u64(&self) -> u64

pub(crate) fn get_i64(&self) -> i64

pub(crate) fn get_double(&self) -> f64

pub(crate) fn get_elem_count(&self) -> usize

pub(crate) fn get_literal(&self) -> Option<bool>

pub(crate) fn get_str_bytes(&self) -> Result<&'a [u8]>

pub(crate) fn get_str(&self) -> Result<&'a str>

pub(crate) fn is_zero(&self) -> bool

Trait Implementations

impl<'a> AsMySQLBool for JsonRef<'a>

fn as_mysql_bool(&self, _context: &mut EvalContext) -> Result<bool>

Evaluates into a MySQL logic value.

impl<'a> ChunkRef<'a, JsonRef<'a>> for &'a ChunkedVecJson

fn get_option_ref(self, idx: usize) -> Option<JsonRef<'a>>

fn get_bit_vec(self) -> &'a BitVec

fn phantom_data(self) -> Option<JsonRef<'a>>

impl<'a> Clone for JsonRef<'a>

fn clone(&self) -> JsonRef<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> ConvertTo<Decimal> for JsonRef<'a>

fn convert(&self, ctx: &mut EvalContext) -> Result<Decimal>

Port from TiDB’s types.ConvertJSONToDecimal

impl<'a> ConvertTo<NotNan<f64>> for JsonRef<'a>

fn convert(&self, ctx: &mut EvalContext) -> Result<Real>

Converts the given value to T value

impl<'a> ConvertTo<String> for JsonRef<'a>

fn convert(&self, _: &mut EvalContext) -> Result<String>

Converts the given value to T value

impl<'a> ConvertTo<Vec<u8, Global>> for JsonRef<'a>

fn convert(&self, _: &mut EvalContext) -> Result<Bytes>

Converts the given value to T value

impl<'a> ConvertTo<f64> for JsonRef<'a>

fn convert(&self, ctx: &mut EvalContext) -> Result<f64>

Keep compatible with TiDB’s ConvertJSONToFloat function.

impl<'a> Copy for JsonRef<'a>

impl<'a> Debug for JsonRef<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Eq for JsonRef<'a>

impl<'a> EvaluableRef<'a> for JsonRef<'a>

const EVAL_TYPE: EvalType

type EvaluableType = Json

type ChunkedType = &'a ChunkedVecJson

fn borrow_scalar_value(v: &'a ScalarValue) -> Option<Self>

Borrows this concrete type from a ScalarValue in the same type; panics if the varient mismatches.

fn borrow_scalar_value_ref(v: ScalarValueRef<'a>) -> Option<Self>

Borrows this concrete type from a ScalarValueRef in the same type; panics if the varient mismatches.

fn borrow_vector_value(v: &VectorValue) -> &ChunkedVecJson

Borrows a slice of this concrete type from a VectorValue in the same type; panics if the varient mismatches.

fn into_owned_value(self) -> Self::EvaluableType

Convert this reference to owned type

fn from_owned_value(value: &'a Json) -> Self

impl<'a> Ord for JsonRef<'a>

fn cmp(&self, right: &JsonRef<'_>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<JsonRef<'a>> for JsonRef<'a>

fn eq(&self, right: &JsonRef<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialOrd<JsonRef<'a>> for JsonRef<'a>

fn partial_cmp(&self, right: &JsonRef<'_>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for JsonRef<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> ToInt for JsonRef<'a>

fn to_int(&self, ctx: &mut EvalContext, tp: FieldTypeTp) -> Result<i64>

Converts the given value to an i64

fn to_uint(&self, ctx: &mut EvalContext, tp: FieldTypeTp) -> Result<u64>

Converts the given value to an u64

impl<'a> ToString for JsonRef<'a>

fn to_string(&self) -> String

This function is a simple combination and rewrite of serde_json’s to_writer_pretty

impl<'a> UnsafeRefInto<JsonRef<'static>> for JsonRef<'a>

unsafe fn unsafe_into(self) -> JsonRef<'static>

Safety