Struct valence_protocol::Text

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

Expand description

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(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. Read more

§

impl<T> AddAssign<T> for Text
where T: IntoText<'static>,

§

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more

§

impl Clone for Text

§

fn clone(&self) -> Text

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Text

§

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

Formats the value using the given formatter. Read more

source §

impl Decode<'_> for Text

source §

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

Reads this object from the provided byte slice. Read more

§

impl Default for Text

§

fn default() -> Text

Returns the “default value” for a type. Read more

§

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. Read more

§

impl Display for Text

§

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

Formats the value using the given formatter. Read more

source §

impl Encode for Text

source §

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

Writes this object to the provided writer. Read more

source §

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

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

§