Struct Text 

#[non_exhaustive]
pub struct Text {
    pub content: TextContent,
    pub style: TextStyle,
    pub children: Vec<Text>,
    pub metadata: Tag,
}

A component tree, retaining translation keys, styles and ordered children.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: TextContent

The component’s contents before its children.

style: TextStyle

Fields not set here inherit from the enclosing component.

children: Vec<Text>

Components appended in order.

metadata: Tag

Unrecognised component metadata survives an engine round trip, as a compound.

Implementations

impl Text

pub fn new(content: TextContent) -> Text

A component with the given contents, with no style overrides or children.

pub fn validate_depth(&self) -> Result<(), TextFormError>

Check vanilla’s component-depth bound before cloning any node payload. Counts every recursive component relation, including hover names.

pub fn literal(value: impl Into<String>) -> Text

A literal component, with no inherited style overrides or children.

pub fn translate(key: impl Into<String>, arguments: Vec<Text>) -> Text

A translatable component. The key and arguments remain unresolved data.

pub fn append(self, child: Text) -> Text

Append a child without flattening its style or translation.

pub fn with_style(self, style: TextStyle) -> Text

Set this component’s style; children continue to inherit unset fields.

impl Text

pub fn validate(&self) -> Result<(), TextFormError>

Validate component paths, opaque NBT containers and typed profile fields before constructing owned conversion payloads. This does not impose JSON representation restrictions on NBT data; engine emission may refuse those.

pub fn visit_children<'a>(&'a self, visit: impl FnMut(&'a Text, TextRelation))

Visit recursive component slots in their relation order, without cloning. Opaque NBT data is not a component edge.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl From<CommandArgumentError> for Text

fn from(error: CommandArgumentError) -> Text

Converts to this type from the input type.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Text

impl TryFrom<&Text> for TextForm

type Error = TextFormError

The type returned in the event of a conversion error.

fn try_from( value: &Text, ) -> Result<TextForm, <TextForm as TryFrom<&Text>>::Error>

Performs the conversion.

impl TryFrom<TextForm> for Text

type Error = TextFormError

The type returned in the event of a conversion error.

fn try_from(value: TextForm) -> Result<Text, <Text as TryFrom<TextForm>>::Error>

Performs the conversion.

impl Wire for Text

const MIN: usize = TextForm::MIN

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn take(input: &mut Reader<'_>) -> Result<Text, WireError>

Decodes one value, leaving any following bytes for the caller.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.