Skip to main content

EntryObject

Struct EntryObject 

Source
pub struct EntryObject {
    pub kind: Option<Kind>,
    pub value: Value,
    pub comment: Option<String>,
    pub key: Option<String>,
    pub texture: Option<String>,
    pub event: Option<String>,
    pub subtitle: Option<String>,
}
Expand description

An entry’s object form: { "type": ..., "value": ..., "comment": ..., ... }.

Fields§

§kind: Option<Kind>

What the entry is; by default what its value is (string, number, bool).

§value: Value

The text, path, color, number or flag.

§comment: Option<String>

A note for whoever edits the file — never shipped.

§key: Option<String>

Texts: the translation key instead of the default one.

§texture: Option<String>

Images: the texture path under assets/<mod id>/textures/.

§event: Option<String>

Sounds: the sound event name.

§subtitle: Option<String>

Sounds: the subtitle’s translation key.

Trait Implementations§

Source§

impl Schema for EntryObject

Source§

fn shape() -> Shape

What the format looks like.
Source§

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

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

fn write(&self) -> Value

The value, as the format writes it.
Source§

fn absent() -> Option<Self>

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

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.