Struct former::exposed::VectorSubformer

pub struct VectorSubformer<E, Formed, Context, ContainerEnd>
where
    Formed: VectorLike<E> + Default,
    ContainerEnd: FormingEnd<Formed, Context>,
{ /* private fields */ }

A builder for constructing VectorLike containers, facilitating a fluent and flexible interface.

VectorSubformer leverages the VectorLike trait to enable the construction and manipulation of vector-like containers in a builder pattern style, promoting readability and ease of use.

Example

#[ derive( Debug, PartialEq, former::Former ) ]
pub struct StructWithVec
{
  #[ subformer( former::VectorSubformer ) ]
  vec : Vec< &'static str >,
}

let instance = StructWithVec::former()
.vec()
  .push( "apple" )
  .push( "banana" )
  .end()
.form();

assert_eq!( instance, StructWithVec { vec: vec![ "apple", "banana" ] } );

Implementations

impl<E, Formed, Context, ContainerEnd> VectorSubformer<E, Formed, Context, ContainerEnd>

where Formed: VectorLike<E> + Default, ContainerEnd: 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: ContainerEnd ) -> Self

Begins the building process, optionally initializing with a context and formed.

pub fn end(self) -> Context

Finalizes the building process, returning the formed or a context incorporating it.

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

Replaces the current formed with a provided one, allowing for a reset or redirection of the building process.

impl<E, Formed> VectorSubformer<E, Formed, Formed, ReturnFormed>

where Formed: VectorLike<E> + Default,

pub fn new() -> Self

Initializes a new VectorSubformer instance, starting with an empty formed. This function serves as the entry point for the builder pattern.

Returns

A new instance of VectorSubformer with an empty internal formed.

impl<E, Formed, Context, ContainerEnd> VectorSubformer<E, Formed, Context, ContainerEnd>

where Formed: VectorLike<E> + Default, ContainerEnd: FormingEnd<Formed, Context>,

pub fn push<E2>(self, element: E2) -> Self

where E2: Into<E>,

Appends an element to the end of the formed, expanding the internal collection.

Trait Implementations

impl<E: Debug, Formed, Context: Debug, ContainerEnd> Debug for VectorSubformer<E, Formed, Context, ContainerEnd>

where Formed: VectorLike<E> + Default + Debug, ContainerEnd: FormingEnd<Formed, Context> + Debug,

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

Formats the value using the given formatter.

impl<E: Default, Formed, Context: Default, ContainerEnd> Default for VectorSubformer<E, Formed, Context, ContainerEnd>

where Formed: VectorLike<E> + Default + Default, ContainerEnd: FormingEnd<Formed, Context> + Default,

fn default() -> VectorSubformer<E, Formed, Context, ContainerEnd>

Returns the “default value” for a type.

impl<E, Formed, Context, End> FormerBegin<Formed, Formed, Context> for VectorSubformer<E, Formed, Context, End>

where End: FormingEnd<Formed, Context>, Formed: VectorLike<E> + Default,

type End = End

End - Specifies the trait bound for the closure or handler that gets called at the completion of the subforming process. This type must implement the FormingEnd<Formed, Context> trait, which defines how the final transformation or construction of Formed is handled, potentially using the provided Context.

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

Initializes the subforming process by setting the context and specifying an on_end completion handler.