Skip to main content

ModUi

Struct ModUi 

Source
pub struct ModUi {
    pub buttons: Vec<UiButton>,
    pub popups: BTreeMap<String, UiPopup>,
}
Expand description

A mod’s authored launcher-UI schema: which buttons to show for the mod, and which popups they open. popups is a map keyed by popup id so buttons can reference popups by name, and validation can catch a button pointing at a popup that doesn’t exist (see ModUi::validate).

Fields§

§buttons: Vec<UiButton>

Buttons rendered for this mod, in authored order.

§popups: BTreeMap<String, UiPopup>

Popups buttons can open, keyed by popup id. May be empty even when buttons exist (e.g. action-only buttons that don’t open a popup).

Implementations§

Source§

impl ModUi

Source

pub fn validate(&self) -> Result<(), Vec<String>>

Structural validation of the whole ui section:

  • button ids must be unique and non-empty;
  • every button’s action must be non-empty;
  • every button’s popup reference (if any) must name an entry in ModUi::popups, no dangling refs;
  • a select field must offer at least one option;
  • unknown popup/field kind strings are rejected (they parse via the Unknown catch-alls precisely so this check can describe them instead of a raw serde error).
§Errors

Returns every problem found (not just the first), matching crate::mod_config::ModConfig::validate’s collect-everything convention.

Trait Implementations§

Source§

impl Clone for ModUi

Source§

fn clone(&self) -> ModUi

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModUi

Source§

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

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

impl Default for ModUi

Source§

fn default() -> ModUi

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

impl<'de> Deserialize<'de> for ModUi

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ModUi

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 ModUi

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

Auto Trait Implementations§

§

impl Freeze for ModUi

§

impl RefUnwindSafe for ModUi

§

impl Send for ModUi

§

impl Sync for ModUi

§

impl Unpin for ModUi

§

impl UnsafeUnpin for ModUi

§

impl UnwindSafe for ModUi

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.

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,