Trait EguiStruct 

pub trait EguiStruct: EguiStructClone + EguiStructEq {
    type ConfigType<'a>: Default;

    const SIMPLE: bool = true;

    // Provided methods
    fn has_childs(&self) -> bool { ... }
    fn has_primitive(&self) -> bool { ... }
    fn show_top(
        &mut self,
        ui: &mut Ui,
        label: impl Into<WidgetText> + Clone,
        reset2: Option<&Self>,
    ) -> Response
       where Self: 'static { ... }
    fn show_collapsing(
        &mut self,
        ui: &mut Ui,
        label: impl Into<WidgetText> + Clone,
        hint: impl Into<WidgetText> + Clone,
        indent_level: isize,
        config: Self::ConfigType<'_>,
        reset2: Option<&Self>,
        parent_id: Id,
    ) -> Response { ... }
    fn show_primitive(
        &mut self,
        ui: &mut Ui,
        _config: Self::ConfigType<'_>,
        _id: impl Hash + Clone,
    ) -> Response { ... }
    fn show_childs(
        &mut self,
        _ui: &mut Ui,
        _indent_level: isize,
        _response: Response,
        _reset2: Option<&Self>,
        _parent_id: Id,
    ) -> Response { ... }
    fn start_collapsed(&self) -> bool { ... }
}

Trait, that allows generating mutable view of data (takes &mut data)

For end user (if you implement trait with macro & not manualy) ofers one function .show_top(), which displays struct inside scroll area.

Provided Associated Constants

const SIMPLE: bool = true

Flag that indicates that data can be shown in the same line as parent (set to true if data is shown as single&simple widget)

Required Associated Types

type ConfigType<'a>: Default

Type that will pass some data to customise how data is shown, in most cases this will be () (eg. for numerics this is ConfigNum)

Provided Methods

fn has_childs(&self) -> bool

Indicates if data has childs section at the moment

fn has_primitive(&self) -> bool

Indicates if data has primitive section at the moment

fn show_top( &mut self, ui: &mut Ui, label: impl Into<WidgetText> + Clone, reset2: Option<&Self>, ) -> Response

where Self: 'static,

Show data in view contained ScrollArea&Grid

You should rather not need to override default impl

fn show_collapsing( &mut self, ui: &mut Ui, label: impl Into<WidgetText> + Clone, hint: impl Into<WidgetText> + Clone, indent_level: isize, config: Self::ConfigType<'_>, reset2: Option<&Self>, parent_id: Id, ) -> Response

Do not overide this method.

Use it when implementing .show_childs() to display single nested element

fn show_primitive( &mut self, ui: &mut Ui, _config: Self::ConfigType<'_>, _id: impl Hash + Clone, ) -> Response

UI elements shown in the same line as label

If data element view is fully contained in childs section(does not have primitive section), leave this & .has_primitive() with default impl

fn show_childs( &mut self, _ui: &mut Ui, _indent_level: isize, _response: Response, _reset2: Option<&Self>, _parent_id: Id, ) -> Response

UI elements related to nested data, that is show inside collapsible rows

If data element view is simple & can fully be contained in primitive section, leave this & .has_childs() with default impl

fn start_collapsed(&self) -> bool

Controls if struct is initally collapsed/uncollapsed (if “show_childs” is shown by default)

eg. Collections (vecs, slices, hashmaps, ..) are initially collapsed if they have more than 16 elements

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl EguiStruct for bool

type ConfigType<'a> = ()

fn show_primitive( &mut self, ui: &mut Ui, _config: Self::ConfigType<'_>, _id: impl Hash + Clone, ) -> Response

impl EguiStruct for f32

type ConfigType<'a> = ConfigNum<'a, f32>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for f64

type ConfigType<'a> = ConfigNum<'a, f64>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for i8

type ConfigType<'a> = ConfigNum<'a, i8>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for i16

type ConfigType<'a> = ConfigNum<'a, i16>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for i32

type ConfigType<'a> = ConfigNum<'a, i32>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for i64

type ConfigType<'a> = ConfigNum<'a, i64>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for i128

type ConfigType<'a> = ()

fn show_primitive( &mut self, ui: &mut Ui, _config: Self::ConfigType<'_>, _id: impl Hash + Clone, ) -> Response

impl EguiStruct for isize

type ConfigType<'a> = ConfigNum<'a, isize>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for u8

type ConfigType<'a> = ConfigNum<'a, u8>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for u16

type ConfigType<'a> = ConfigNum<'a, u16>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for u32

type ConfigType<'a> = ConfigNum<'a, u32>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for u64

type ConfigType<'a> = ConfigNum<'a, u64>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for u128

type ConfigType<'a> = ()

fn show_primitive( &mut self, ui: &mut Ui, _config: Self::ConfigType<'_>, _id: impl Hash + Clone, ) -> Response

impl EguiStruct for usize

type ConfigType<'a> = ConfigNum<'a, usize>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl EguiStruct for String

type ConfigType<'a> = ConfigStr<'a>

fn show_primitive( &mut self, ui: &mut Ui, config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

impl<Q: ToString + Eq + Hash, V: EguiStruct> EguiStruct for HashMap<Q, V>

const SIMPLE: bool = false

type ConfigType<'a> = ()

fn has_childs(&self) -> bool

fn has_primitive(&self) -> bool

fn show_childs( &mut self, ui: &mut Ui, indent_level: isize, response: Response, _reset2: Option<&Self>, id: Id, ) -> Response

fn start_collapsed(&self) -> bool

impl<T: EguiStruct + Default> EguiStruct for Option<T>

const SIMPLE: bool = false

type ConfigType<'a> = ()

fn has_childs(&self) -> bool

fn has_primitive(&self) -> bool

fn show_primitive( &mut self, ui: &mut Ui, _config: Self::ConfigType<'_>, id: impl Hash + Clone, ) -> Response

fn show_childs( &mut self, ui: &mut Ui, indent_level: isize, response: Response, reset2: Option<&Self>, id: Id, ) -> Response

impl<T: EguiStruct> EguiStruct for [T]

const SIMPLE: bool = false

type ConfigType<'a> = ()

fn has_childs(&self) -> bool

fn has_primitive(&self) -> bool

fn show_childs( &mut self, ui: &mut Ui, indent_level: isize, response: Response, _reset2: Option<&Self>, id: Id, ) -> Response

fn start_collapsed(&self) -> bool

impl<T: EguiStruct> EguiStruct for Vec<T>

const SIMPLE: bool = false

type ConfigType<'a> = ()

fn has_childs(&self) -> bool

fn has_primitive(&self) -> bool

fn show_childs( &mut self, ui: &mut Ui, indent_level: isize, response: Response, _reset2: Option<&Self>, id: Id, ) -> Response

fn start_collapsed(&self) -> bool

Implementors

impl<T: Clone + ToString + PartialEq + 'static> EguiStruct for Combobox<T>

type ConfigType<'a> = Option<&'a mut dyn Iterator<Item = T>>