Struct TextComponent 

#[repr(transparent)]
pub struct TextComponent {
    pub text: Text,
}

Fields

text: Text

Implementations

impl TextComponent

pub fn from_cow_text<'a>(cow: Cow<'a, Text>) -> Cow<'a, TextComponent>

Zero-copy cast from a Cow<Text> to a Cow<TextComponent>.

Safety

This is safe because TextComponent is #[repr(transparent)] wrapper around Text.

pub fn as_text(&self) -> &Text

Trait Implementations

impl Clone for TextComponent

fn clone(&self) -> TextComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextComponent

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

Formats the value using the given formatter.

impl Decode<'_> for TextComponent

fn decode(r: &mut &[u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl Encode for TextComponent

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl From<Text> for TextComponent

fn from(value: Text) -> Self

Converts to this type from the input type.

impl<'a> IntoText<'a> for TextComponent

fn into_cow_text(self) -> Cow<'a, Text>

Converts to a Text object, either owned or borrowed.

fn into_text(self) -> Text

Converts to an owned Text object.

fn color(self, color: impl Into<Color>) -> Text

Sets the color of the text.

fn clear_color(self) -> Text

Clears the color of the text. Color of parent Text object will be used.

fn font(self, font: Font) -> Text

Sets the font of the text.

fn clear_font(self) -> Text

Clears the font of the text. Font of parent Text object will be used.

fn bold(self) -> Text

Makes the text bold.

fn not_bold(self) -> Text

Makes the text not bold.

fn clear_bold(self) -> Text

Clears the bold property of the text. Property of the parent Text object will be used.

fn italic(self) -> Text

Makes the text italic.

fn not_italic(self) -> Text

Makes the text not italic.

fn clear_italic(self) -> Text

Clears the italic property of the text. Property of the parent Text object will be used.

fn underlined(self) -> Text

Makes the text underlined.

fn not_underlined(self) -> Text

Makes the text not underlined.

fn clear_underlined(self) -> Text

Clears the underlined property of the text. Property of the parent Text object will be used.

fn strikethrough(self) -> Text

Adds a strikethrough effect to the text.

fn not_strikethrough(self) -> Text

Removes the strikethrough effect from the text.

fn clear_strikethrough(self) -> Text

Clears the strikethrough property of the text. Property of the parent Text object will be used.

fn obfuscated(self) -> Text

Makes the text obfuscated.

fn not_obfuscated(self) -> Text

Makes the text not obfuscated.

fn clear_obfuscated(self) -> Text

Clears the obfuscated property of the text. Property of the parent Text object will be used.

fn insertion(self, insertion: impl Into<Cow<'static, str>>) -> Text

Adds an insertion property to the text. When shift-clicked, the given text will be inserted into chat box for the client.

fn clear_insertion(self) -> Text

Clears the insertion property of the text. Property of the parent Text object will be used.

fn on_click_open_url(self, url: impl Into<Cow<'static, str>>) -> Text

On click, opens the given URL. Has to be http or https protocol.

fn on_click_run_command(self, command: impl Into<Cow<'static, str>>) -> Text

On click, sends a command. Doesn’t actually have to be a command, can be a simple chat message.

fn on_click_suggest_command(self, command: impl Into<Cow<'static, str>>) -> Text

On click, copies the given text to the chat box.

fn on_click_change_page(self, page: impl Into<i32>) -> Text

On click, turns the page of the opened book to the given number. Indexing starts at 1.

fn on_click_copy_to_clipboard(self, text: impl Into<Cow<'static, str>>) -> Text

On click, copies the given text to clipboard.

fn clear_click_event(self) -> Text

Clears the click_event property of the text. Property of the parent Text object will be used.

fn on_hover_show_text(self, text: impl IntoText<'static>) -> Text

On mouse hover, shows the given text in a tooltip.

fn clear_hover_event(self) -> Text

Clears the hover_event property of the text. Property of the parent Text object will be used.

fn add_child(self, text: impl IntoText<'static>) -> Text

Adds a child Text object.

impl PartialEq for TextComponent

fn eq(&self, other: &TextComponent) -> 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 StructuralPartialEq for TextComponent