Struct valence::protocol::Text

pub struct Text(/* private fields */);

Represents formatted text in Minecraft’s JSON text format.

Text is used in various places such as chat, window titles, disconnect messages, written books, signs, and more.

For more information, see the relevant Minecraft Wiki article.

Examples

With IntoText in scope, you can write the following:

use valence_text::{Color, IntoText, Text};

let txt = "The text is ".into_text()
    + "Red".color(Color::RED)
    + ", "
    + "Green".color(Color::GREEN)
    + ", and also "
    + "Blue".color(Color::BLUE)
    + "! And maybe even "
    + "Italic".italic()
    + ".";

assert_eq!(
    txt.to_string(),
    r#"{"text":"The text is ","extra":[{"text":"Red","color":"red"},{"text":", "},{"text":"Green","color":"green"},{"text":", and also "},{"text":"Blue","color":"blue"},{"text":"! And maybe even "},{"text":"Italic","italic":true},{"text":"."}]}"#
);

Implementations

impl Text

pub fn text<P>(plain: P) -> Text

where P: Into<Cow<'static, str>>,

Constructs a new plain text object.

pub fn translate<K, W>(key: K, with: W) -> Text

where K: Into<Cow<'static, str>>, W: Into<Vec<Text>>,

Create translated text based on the given translation key, with extra text components to be inserted into the slots of the translation text.

pub fn score<N, O>( name: N, objective: O, value: Option<Cow<'static, str>>, ) -> Text

where N: Into<Cow<'static, str>>, O: Into<Cow<'static, str>>,

Create a score from the scoreboard with an optional custom value.

pub fn selector<S>(selector: S, separator: Option<Text>) -> Text

where S: Into<Cow<'static, str>>,

Creates a text component for selecting entity names with an optional custom separator.

pub fn keybind<K>(keybind: K) -> Text

where K: Into<Cow<'static, str>>,

Creates a text component for a keybind. The keybind should be a valid keybind identifier.

pub fn block_nbt<B, N>( block: B, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Text

where B: Into<Cow<'static, str>>, N: Into<Cow<'static, str>>,

Creates a text component for a block NBT tag.

pub fn entity_nbt<E, N>( entity: E, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Text

where E: Into<Cow<'static, str>>, N: Into<Cow<'static, str>>,

Creates a text component for an entity NBT tag.

pub fn storage_nbt<S, N>( storage: S, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Text

where S: Into<Ident<Cow<'static, str>>>, N: Into<Cow<'static, str>>,

Creates a text component for a command storage NBT tag.

pub fn is_empty(&self) -> bool

Returns true if the text contains no characters. Returns false otherwise.

pub fn to_legacy_lossy(&self) -> String

Converts the Text object to a plain string with the legacy formatting (§ and format codes)

Removes everything that can’t be represented with a § and a modifier. Any colors not on the the legacy color list will be replaced with their closest equivalent.

Trait Implementations

impl<T> Add<T> for Text

where T: IntoText<'static>,

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <Text as Add<T>>::Output

Performs the + operation.

impl<T> AddAssign<T> for Text

where T: IntoText<'static>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Text

fn clone(&self) -> Text

Returns a copy 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 Decode<'_> for Text

fn decode(r: &mut &[u8]) -> Result<Text, Error>

Reads this object from the provided byte slice.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl Deref for Text

type Target = TextInner

The resulting type after dereferencing.

fn deref(&self) -> &<Text as Deref>::Target

Dereferences the value.

impl DerefMut for Text

fn deref_mut(&mut self) -> &mut <Text as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Text

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Text

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

Formats the value using the given formatter.

impl Encode for Text

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

Writes this object to the provided writer.

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

where Self: Sized,

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

impl<'a, 'b> From<&'a Cow<'b, Text>> for Text

fn from(value: &'a Cow<'b, Text>) -> Text

Converts to this type from the input type.

impl<'a> From<&'a Cow<'static, str>> for Text

fn from(value: &'a Cow<'static, str>) -> Text

Converts to this type from the input type.

impl<'a> From<&'a String> for Text

fn from(value: &'a String) -> Text

Converts to this type from the input type.

impl<'a> From<&'a Text> for Cow<'a, Text>

fn from(value: &'a Text) -> Cow<'a, Text>

Converts to this type from the input type.

impl<'a> From<&'a Text> for Text

fn from(value: &'a Text) -> Text

Converts to this type from the input type.

impl From<&'static str> for Text

fn from(value: &'static str) -> Text

Converts to this type from the input type.

impl<'a> From<Cow<'a, Text>> for Text

fn from(value: Cow<'a, Text>) -> Text

Converts to this type from the input type.

impl From<Cow<'static, str>> for Text

fn from(value: Cow<'static, str>) -> Text

Converts to this type from the input type.

impl From<String> for Text

fn from(value: String) -> Text

Converts to this type from the input type.

impl<'a> From<Text> for Cow<'a, Text>

fn from(value: Text) -> Cow<'a, Text>

Converts to this type from the input type.

impl From<Text> for String

fn from(value: Text) -> String

Converts to this type from the input type.

impl From<Text> for Value

fn from(value: Text) -> Value

Converts to this type from the input type.

impl FromStr for Text

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Text, <Text as FromStr>::Err>

Parses a string s to return a value of this type.

impl<'a> IntoText<'a> for &'a Text

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<'a> IntoText<'a> for Text

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 Text

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

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

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

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

impl Serialize for Text

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 StructuralPartialEq for Text