Struct panoramix::elements::ElementList

pub struct ElementList<Child: Element<CpEvent, CpState>, CpEvent = NoEvent, CpState = ()> {
    pub children: Vec<(String, Child)>,
    pub _comp_state: PhantomData<CpState>,
    pub _comp_event: PhantomData<CpEvent>,
}

A list of elements of the same type.

Events

Doesn’t emit events.

About keys

ElementList stores a Vec of (String, Child), where the string must be a unique key.

Keys help Panoramix figure out element identity, and maintain widget persistence. For instance, if your element list before update looks like:

[
    ("foo-1", MyComponent("foo")),
    ("foo-2", MyComponent("foo")),
    ("bar-3", MyComponent("bar")),
];

and your element list post-update looks like:

[
    ("foo-1", MyComponent("foo")),
    ("bar-3", MyComponent("bar")),
];

Panoramix will figure out that the element at foo-2 has been removed, and will remove it from the underlying widget tree, as well as perform any necessary cleanup.

Fields

children: Vec<(String, Child)>

_comp_state: PhantomData<CpState>

_comp_event: PhantomData<CpEvent>

Implementations

impl<CpEvent, CpState, Child: Element<CpEvent, CpState>> ElementList<Child, CpEvent, CpState>

pub fn from_pairs(pairs: impl IntoIterator<Item = (String, Child)>) -> Self

Build a list by providing an iterator of (Key, Element) pairs.

pub fn from_keys_elems(
    keys: impl IntoIterator<Item = String>,
    elems: impl IntoIterator<Item = Child>
) -> Self

Build a list by providing keys and elements as separate iterators.

Trait Implementations

impl<Child: Element<CpEvent, CpState>, CpEvent, CpState> Clone for ElementList<Child, CpEvent, CpState> where
    Child: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Child: Element<CpEvent, CpState>, CpEvent, CpState> Debug for ElementList<Child, CpEvent, CpState>

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

Formats the value using the given formatter.

impl<Child: Element<CpEvent, CpState>, CpEvent, CpState> Default for ElementList<Child, CpEvent, CpState>

fn default() -> Self

Returns the “default value” for a type.

impl<CpEvent, CpState, Child: Element<CpEvent, CpState>> Element<CpEvent, CpState> for ElementList<Child, CpEvent, CpState>

type Event = NoEvent

The type of events this element can raise.

type AggregateChildrenState = Vec<(String, Child::AggregateChildrenState)>

type BuildOutput = ElementListData<Child::BuildOutput, CpEvent, CpState>

fn build(
    self,
    prev_state: Self::AggregateChildrenState
) -> (Self::BuildOutput, Self::AggregateChildrenState)

impl<Child: Eq + Element<CpEvent, CpState>, CpEvent: Eq, CpState: Eq> Eq for ElementList<Child, CpEvent, CpState>

impl<Child: Hash + Element<CpEvent, CpState>, CpEvent: Hash, CpState: Hash> Hash for ElementList<Child, CpEvent, CpState>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Child: PartialEq + Element<CpEvent, CpState>, CpEvent: PartialEq, CpState: PartialEq> PartialEq<ElementList<Child, CpEvent, CpState>> for ElementList<Child, CpEvent, CpState>

fn eq(&self, other: &ElementList<Child, CpEvent, CpState>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ElementList<Child, CpEvent, CpState>) -> bool

This method tests for !=.

impl<Child: Element<CpEvent, CpState>, CpEvent, CpState> StructuralEq for ElementList<Child, CpEvent, CpState>

impl<Child: Element<CpEvent, CpState>, CpEvent, CpState> StructuralPartialEq for ElementList<Child, CpEvent, CpState>