.. module:: brownie.datastructures

Datastructures
==============

This module provides various datastructures.

.. autodata:: missing

.. autofunction:: iter_multi_items

.. autoclass:: StackedObject
   :members:

Mappings
--------

.. autoclass:: MultiDict
   :members: add, getlist, setlist, setlistdefault, lists, listvalues,
             iterlists, iterlistvalues, poplist, popitemlist

.. autoclass:: OrderedDict
   :members: popitem, move_to_end

.. autoclass:: Counter
   :members:

.. autoclass:: OrderedMultiDict
   :members:

.. autoclass:: FixedDict
   :members:

Immutable Mappings
------------------

.. autoclass:: ImmutableDict
   :members:

.. autoclass:: ImmutableMultiDict
   :members:

.. autoclass:: ImmutableOrderedDict
   :members:

.. autoclass:: ImmutableOrderedMultiDict
   :members:

Combining Mappings
------------------

.. autoclass:: CombinedDict
   :members:

.. autoclass:: CombinedMultiDict
   :members:

Sequences
---------

.. autoclass:: LazyList
   :members: factory, count, index, insert, pop, remove, reverse, sort

.. autoclass:: CombinedSequence
   :members:

.. autoclass:: CombinedList
   :members:

.. autofunction:: namedtuple

Sets
----

.. autoclass:: OrderedSet
   :members:

Queues
------

.. autoclass:: SetQueue
   :members:
   :inherited-members:
   :show-inheritance:

Iterators
---------

.. autoclass:: PeekableIterator
   :members: