Enum FormattedText 

pub enum FormattedText {
    Text(TextComponent),
    Translatable(TranslatableComponent),
}

A chat component, basically anything you can see in chat.

Variants

Text(TextComponent)

Translatable(TranslatableComponent)

Implementations

impl FormattedText

A chat component

pub fn get_base_mut(&mut self) -> &mut BaseComponent

pub fn get_base(&self) -> &BaseComponent

pub fn to_custom_format<F, S, C>( &self, style_formatter: F, text_formatter: S, cleanup_formatter: C, default_style: &Style, ) -> String

where F: FnMut(&Style, &Style) -> (String, String), S: FnMut(&str) -> String, C: FnMut(&Style) -> String,

Render all components into a single String, using your custom closures to drive styling, text transformation, and final cleanup.

Type params

• F: (running, component, default) -> (prefix, suffix) for per-component styling
• S: &str -> String for text tweaks (escaping, mapping, etc.)
• C: &final_running_style -> String for any trailing cleanup

Args

• style_formatter: how to open/close each component’s style
• text_formatter: how to turn raw text into output text
• cleanup_formatter: emit after all components (e.g. reset codes)
• default_style: where to reset when a component’s reset is true

Example

use azalea_chat::{FormattedText, DEFAULT_STYLE};
use serde::de::Deserialize;

let component = FormattedText::deserialize(&serde_json::json!({
   "text": "Hello, world!",
   "color": "red",
})).unwrap();

let ansi = component.to_custom_format(
    |running, new| (running.compare_ansi(new), "".to_string()),
    |text| text.to_string(),
    |style| {
        if !style.is_empty() {
            "\u{1b}[m".to_string()
        } else {
            "".to_string()
        }
    },
    &DEFAULT_STYLE,
);
println!("{ansi}");

pub fn to_ansi_with_custom_style(&self, default_style: &Style) -> String

Convert this component into an ANSI string.

This is the same as FormattedText::to_ansi, but you can specify a default [Style] to use.

pub fn to_ansi(&self) -> String

Convert this component into an ANSI string, so you can print it to your terminal and get styling.

This is technically a shortcut for FormattedText::to_ansi_with_custom_style with a default [Style] colored white.

If you don’t want the result to be styled at all, use Self::to_string.

Examples

use azalea_chat::FormattedText;
use serde::de::Deserialize;

let component = FormattedText::deserialize(&serde_json::json!({
   "text": "Hello, world!",
   "color": "red",
})).unwrap();

println!("{}", component.to_ansi());

pub fn to_html(&self) -> String

Similar to Self::to_ansi but renders the result as HTML instead.

impl FormattedText

pub fn from_nbt_compound(compound: NbtCompound<'_, '_>) -> Option<FormattedText>

Trait Implementations

impl AzaleaRead for FormattedText

fn azalea_read(buf: &mut Cursor<&[u8]>) -> Result<FormattedText, BufReadError>

impl AzaleaWrite for FormattedText

fn azalea_write(&self, buf: &mut impl Write) -> Result<(), Error>

impl Clone for FormattedText

fn clone(&self) -> FormattedText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormattedText

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

Formats the value using the given formatter.

impl Default for FormattedText

fn default() -> FormattedText

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FormattedText

fn deserialize<D>( de: D, ) -> Result<FormattedText, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FormattedText

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

Render the text in the component but without any formatting/styling.

If you want the text to be styled, consider using Self::to_ansi or Self::to_html.

impl From<&Mutf8Str> for FormattedText

fn from(s: &Mutf8Str) -> FormattedText

Converts to this type from the input type.

impl From<&str> for FormattedText

fn from(s: &str) -> FormattedText

Converts to this type from the input type.

impl From<String> for FormattedText

fn from(s: String) -> FormattedText

Converts to this type from the input type.

impl From<TextComponent> for FormattedText

fn from(c: TextComponent) -> FormattedText

Converts to this type from the input type.

impl From<TranslatableComponent> for FormattedText

fn from(c: TranslatableComponent) -> FormattedText

Converts to this type from the input type.

impl FromNbtTag for FormattedText

fn from_nbt_tag(tag: NbtTag<'_, '_>) -> Option<FormattedText>

fn from_optional_nbt_tag( tag: Option<NbtTag<'_, '_>>, ) -> Result<Option<Self>, DeserializeError>

impl IntoIterator for FormattedText

fn into_iter(self) -> <FormattedText as IntoIterator>::IntoIter

Recursively call the function for every component in this component

type Item = FormattedText

The type of the elements being iterated over.

type IntoIter = IntoIter<<FormattedText as IntoIterator>::Item>

Which kind of iterator are we turning this into?

impl PartialEq for FormattedText

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FormattedText

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for FormattedText

fn to_compound(self) -> NbtCompound

fn to_nbt(self) -> BaseNbt

impl StructuralPartialEq for FormattedText