Struct former::exposed::HashMapSubformer

pub struct HashMapSubformer<K, E, Formed, Context, End>
where
    K: Eq + Hash,
    Formed: HashMapLike<K, E> + Default,
    End: FormingEnd<Formed, Context>,
{ /* private fields */ }

A builder for constructing hash map-like structures with a fluent interface.

HashMapSubformer leverages the HashMapLike trait to enable a flexible and customizable way to build hash map-like structures. It supports the chaining of insert operations and allows for the definition of custom end actions to finalize the building process.

Type Parameters

• K: Key type, must implement Eq and Hash.
• E: Element (value) type.
• Formed: The hash map-like formed being built.
• Context: Type of the optional context used during the building process.
• End: End-of-forming action to be executed upon completion.

Examples

#[ derive( Debug, PartialEq, former::Former ) ]
pub struct StructWithMap
{
  #[ subformer( former::HashMapSubformer ) ]
  map : std::collections::HashMap< &'static str, &'static str >,
}

let struct1 = StructWithMap::former()
.map()
  .insert( "a", "b" )
  .insert( "c", "d" )
  .end()
.form()
;
assert_eq!( struct1, StructWithMap { map : hmap!{ "a" => "b", "c" => "d" } } );

Implementations

impl<K, E, Formed, Context, End> HashMapSubformer<K, E, Formed, Context, End>

where K: Eq + Hash, Formed: HashMapLike<K, E> + Default, End: FormingEnd<Formed, Context>,

pub fn form(self) -> Formed

Form current former into target structure.

pub fn begin( formed: Option<Formed>, context: Option<Context>, on_end: End ) -> Self

Make a new HashMapSubformer. It should be called by a context generated for your structure. The context is returned after completion of forming by function `on_end``.

pub fn end(self) -> Context

Return context of your struct moving formed there. Should be called after configuring the formed.

pub fn replace(self, formed: Formed) -> Self

Set the whole formed instead of setting each element individually.

impl<K, E, Formed> HashMapSubformer<K, E, Formed, Formed, ReturnFormed>

where K: Eq + Hash, Formed: HashMapLike<K, E> + Default,

pub fn new() -> Self

Create a new instance without context or on end processing. It just returns continaer on end of forming.

impl<K, E, Formed, Context, End> HashMapSubformer<K, E, Formed, Context, End>

where K: Eq + Hash, Formed: HashMapLike<K, E> + Default, End: FormingEnd<Formed, Context>,

pub fn insert<K2, E2>(self, k: K2, e: E2) -> Self

where K2: Into<K>, E2: Into<E>,

Inserts a key-value pair into the formed. If the formed doesn’t exist, it is created.

Parameters

• k: The key for the value to be inserted. Will be converted into the formed’s key type.
• e: The value to be inserted. Will be converted into the formed’s value type.

Returns

Returns self for chaining further insertions or operations.

pub fn push<K2, E2>(self, k: K2, e: E2) -> Self

where K2: Into<K>, E2: Into<E>,

Alias for insert.

Parameters

• k: The key for the value to be inserted. Will be converted into the formed’s key type.
• e: The value to be inserted. Will be converted into the formed’s value type.

Returns

Returns self for chaining further insertions or operations.

Trait Implementations

impl<K, E: Debug, Formed, Context: Debug, End> Debug for HashMapSubformer<K, E, Formed, Context, End>

where K: Eq + Hash + Debug, Formed: HashMapLike<K, E> + Default + Debug, End: FormingEnd<Formed, Context> + Debug,

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

Formats the value using the given formatter.

impl<K, E: Default, Formed, Context: Default, End> Default for HashMapSubformer<K, E, Formed, Context, End>

where K: Eq + Hash + Default, Formed: HashMapLike<K, E> + Default + Default, End: FormingEnd<Formed, Context> + Default,

fn default() -> HashMapSubformer<K, E, Formed, Context, End>

Returns the “default value” for a type.