Struct JsonTextComponent 

pub struct JsonTextComponent(pub JsonComponent);

A text component encoded as JSON in a protocol string.

Since Java Edition 1.20.3, the vanilla implementation permits up to 262,144 UTF-16 code units when decoding but refuses to encode more than 32,767. See the text component format.

Tuple Fields

0: JsonComponent

The structured text component value.

Implementations

impl JsonTextComponent

pub const MAX_DECODE_UTF16_CODE_UNITS: usize = 262_144

The maximum number of UTF-16 code units accepted while decoding.

pub const MAX_DECODE_BYTES: usize

The maximum decoded UTF-8 payload size, excluding its VarInt length prefix.

pub const MAX_DECODE_ENCODED_BYTES: usize

The maximum decoded size, including the VarInt length prefix.

pub const MAX_ENCODE_UTF16_CODE_UNITS: usize = 32_767

The maximum number of UTF-16 code units permitted while encoding.

Vanilla Java Edition 1.20.3 and later still refuses to encode larger JSON components despite accepting them while decoding.

pub const MAX_ENCODE_BYTES: usize

The maximum encoded UTF-8 payload size, excluding its VarInt length prefix.

pub const MAX_ENCODE_ENCODED_BYTES: usize

The maximum encoded size, including the VarInt length prefix.

pub fn text(value: impl Into<String>) -> Self

Creates a plain-text component.

pub fn from_json_str(value: &str) -> Result<Self, CodecError>

Parses and validates a text component from JSON without a length prefix.

On failure, the number of bytes of value is reported as CodecError::bytes_processed.

Errors

Returns a CodecError if value is invalid JSON, does not represent a text component, or exceeds the supported nesting depth.

Trait Implementations

impl Clone for JsonTextComponent

fn clone(&self) -> JsonTextComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonTextComponent

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

Formats the value using the given formatter.

impl Default for JsonTextComponent

fn default() -> Self

Returns the “default value” for a type.

impl From<&str> for JsonTextComponent

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Component<Value>> for JsonTextComponent

fn from(value: JsonComponent) -> Self

Converts to this type from the input type.

impl From<String> for JsonTextComponent

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for JsonTextComponent

fn eq(&self, other: &JsonTextComponent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for JsonTextComponent

impl TypeCodec for JsonTextComponent

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>