Style

Struct Style 

Source
#[non_exhaustive]
pub struct Style { pub color: Option<TextColor>, pub shadow_color: Option<u32>, pub bold: Option<bool>, pub italic: Option<bool>, pub underlined: Option<bool>, pub strikethrough: Option<bool>, pub obfuscated: Option<bool>, pub click_event: Option<ClickEvent>, pub hover_event: Option<HoverEvent>, pub insertion: Option<String>, pub font: Option<String>, }

Fields (Non-exhaustive)§

This struct is marked as 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.
§color: Option<TextColor>§shadow_color: Option<u32>§bold: Option<bool>§italic: Option<bool>§underlined: Option<bool>§strikethrough: Option<bool>§obfuscated: Option<bool>§click_event: Option<ClickEvent>§hover_event: Option<HoverEvent>§insertion: Option<String>§font: Option<String>

Represented as a ResourceLocation.

Implementations§

Source§

impl Style

Source

pub fn new() -> Self

Source

pub fn color(self, color: impl Into<Option<TextColor>>) -> Self

Source

pub fn shadow_color(self, color: impl Into<Option<u32>>) -> Self

Source

pub fn bold(self, bold: impl Into<Option<bool>>) -> Self

Source

pub fn italic(self, italic: impl Into<Option<bool>>) -> Self

Source

pub fn underlined(self, underlined: impl Into<Option<bool>>) -> Self

Source

pub fn strikethrough(self, strikethrough: impl Into<Option<bool>>) -> Self

Source

pub fn obfuscated(self, obfuscated: impl Into<Option<bool>>) -> Self

Source

pub fn click_event(self, click_event: impl Into<Option<ClickEvent>>) -> Self

Source

pub fn hover_event(self, hover_event: impl Into<Option<HoverEvent>>) -> Self

Source

pub fn insertion(self, insertion: impl Into<Option<String>>) -> Self

Source

pub fn font(self, font: impl Into<Option<String>>) -> Self

Source§

impl Style

Source

pub fn empty() -> Self

Source

pub fn deserialize(json: &Value) -> Style

Source

pub fn is_empty(&self) -> bool

Check if a style has no attributes set

Source

pub fn compare_ansi(&self, after: &Style) -> String

find the necessary ansi code to get from this style to another

Source

pub fn apply(&mut self, style: &Style)

Apply another style to this one

Source

pub fn merged_with(&self, other: &Style) -> Style

Returns a new style that is a merge of self and other. For any field that other does not specify (is None), self’s value is used.

Source

pub fn apply_formatting(&mut self, formatting: &ChatFormatting)

Apply a ChatFormatting to this style

Source

pub fn get_html_style(&self) -> String

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Style

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Style

Source§

fn default() -> Style

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

impl Deserialize for Style

Source§

fn from_compound( compound: NbtCompound<'_, '_>, ) -> Result<Self, DeserializeError>

§

fn from_nbt(nbt: &BaseNbt<'_>) -> Result<Self, DeserializeError>

Source§

impl PartialEq for Style

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Style

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Serialize for Style

Source§

fn to_compound(self) -> NbtCompound

§

fn to_nbt(self) -> BaseNbt

Source§

impl StructuralPartialEq for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

impl RefUnwindSafe for Style

§

impl Send for Style

§

impl Sync for Style

§

impl Unpin for Style

§

impl UnwindSafe for Style

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromNbtTag for T
where T: Deserialize,

§

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

§

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

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToNbtTag for T
where T: Serialize,

§

fn to_nbt_tag(self) -> NbtTag

§

fn to_optional_nbt_tag(self) -> Option<NbtTag>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more