Struct ouroboros_examples::DocumentationExampleBuilder

pub struct DocumentationExampleBuilder<IntReferenceBuilder_: for<'this> FnOnce(&'this <Box<i32> as Deref>::Target) -> &'this i32, FloatReferenceBuilder_: for<'this> FnOnce(&'this mut <Box<f32> as Deref>::Target) -> &'this mut f32> {
    pub int_data: Box<i32>,
    pub float_data: Box<f32>,
    pub int_reference_builder: IntReferenceBuilder_,
    pub float_reference_builder: FloatReferenceBuilder_,
}

A more verbose but stable way to construct self-referencing structs. It is comparable to using StructName { field1: value1, field2: value2 } rather than StructName::new(value1, value2). This has the dual benefit of making your code both easier to refactor and more readable. Call build() to construct the actual struct. The fields of this struct should be used as follows:

Field	Suggested Use
int_data	Directly pass in the value this field should contain
float_data	Directly pass in the value this field should contain
int_reference_builder	Use a function or closure: (int_data: &_) -> int_reference: _
float_reference_builder	Use a function or closure: (float_data: &mut _) -> float_reference: _

Fields

int_data: Box<i32>

float_data: Box<f32>

int_reference_builder: IntReferenceBuilder_

float_reference_builder: FloatReferenceBuilder_

Implementations

impl<IntReferenceBuilder_: for<'this> FnOnce(&'this <Box<i32> as Deref>::Target) -> &'this i32, FloatReferenceBuilder_: for<'this> FnOnce(&'this mut <Box<f32> as Deref>::Target) -> &'this mut f32> DocumentationExampleBuilder<IntReferenceBuilder_, FloatReferenceBuilder_>

pub fn build(self) -> DocumentationExample

Calls DocumentationExample::new() using the provided values. This is preferrable over calling new() directly for the reasons listed above.