Enum Text 

pub enum Text {
    Literal(String),
    Res(Res),
    NameOf(Ref),
    Lang(String),
}

A text a player reads: Yog text as written ({b|bold}), a .yres text (@res:Strings.title), the name of some content (@item:minecraft:stick shows “Stick”), or a translation key (@lang:gui.done).

Variants

Literal(String)

Res(Res)

NameOf(Ref)

Lang(String)

Implementations

impl Text

pub fn to_ref(&self) -> Option<Ref>

The reference it is, if it’s one (@res:…, @lang:…, a name’s).

pub fn resolve(self, cx: &mut Reader<'_>) -> Option<String>

What the tool reading it makes of it: its words as written, else what the resolver expands its reference to (a .yres text’s words or translation key, an item’s name), else its reference as written.

pub fn of_ref(r: Ref) -> Option<Text>

What reference r is as a text (a resolver’s expand gets the reference a text is).

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl NamedType for Text

const NAME: &'static str = yog_ids::typed::TEXT

What tools know it by: "color", "date".

type Stored = Value

What it’s stored as.

fn to_stored(&self) -> Value

Its stored form.

fn from_stored(stored: Value) -> Option<Self>

The value stored holds, if it’s a valid one.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for Text

Read as its reference when it’s one, so a tool sees every reference a text makes; every other form is its stored form’s.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Self>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn encode(&self, w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(d: &mut Decoder<'_>) -> Option<Self>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(u: &mut Unpacker<'_>) -> Option<Self>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for Text