Struct Wip

pub struct Wip<'a> { /* private fields */ }

A work-in-progress heap-allocated value

Implementations

impl Wip<'_>

pub fn variant(self, index: usize) -> Result<Self, ReflectError>

Selects a variant of an enum by index.

Arguments

• index - The index of the variant to select.

Returns

• Ok(Self) if the variant was successfully selected.
• Err(ReflectError) if the current frame is not an enum or the variant index is out of bounds.

pub fn variant_named(self, name: &str) -> Result<Self, ReflectError>

Selects a variant of an enum by name.

Arguments

• name - The name of the variant to select.

Returns

• Ok(Self) if the variant was successfully selected.
• Err(ReflectError) if the current frame is not an enum or no variant with the given name exists.

pub fn find_variant(&self, name: &str) -> Option<(usize, Variant)>

Finds a variant in an enum by name.

Arguments

• name - The name of the variant to find.

Returns

• Some(index, variant) if a variant with the given name exists.
• None if the current frame is not an enum or no variant with the given name exists.

pub fn selected_variant(&self) -> Option<Variant>

Returns the currently selected variant for the enum in the current frame.

Returns

• Some(variant) if the current frame is an enum and a variant has been selected.
• None if the current frame is not an enum or no variant has been selected yet.

impl<'a> Wip<'a>

pub fn frames_count(&self) -> usize

Returns the number of frames on the stack

pub fn alloc_shape(shape: &'static Shape) -> Self

Allocates a new value of the given shape

pub fn alloc<S: Facet>() -> Self

Allocates a new value of type S

pub fn shape(&self) -> &'static Shape

Returns the shape of the current frame

pub fn in_option(&self) -> bool

Return true if the last frame is in option mode

pub fn mode(&self) -> FrameMode

Returns the mode of the current frame

pub fn build(self) -> Result<HeapValue<'a>, ReflectError>

Asserts everything is initialized and that invariants are upheld (if any)

pub fn field(self, index: usize) -> Result<Self, ReflectError>

Selects a field of a struct or enum variant by index and pushes it onto the frame stack.

Arguments

• index - The index of the field to select.

Returns

• Ok(Self) if the field was successfully selected and pushed.
• Err(ReflectError) if the current frame is not a struct or an enum with a selected variant, or if the field doesn’t exist.

pub fn field_index(&self, name: &str) -> Option<usize>

Finds the index of a field in a struct or enum variant by name.

Arguments

• name - The name of the field to find.

Returns

• Some(usize) if the field was found.
• None if the current frame is not a struct or an enum with a selected variant, or if the field doesn’t exist.

pub fn field_named(self, name: &str) -> Result<Self, ReflectError>

Selects a field of a struct or enum variant by name and pushes it onto the frame stack.

Arguments

• name - The name of the field to select.

Returns

• Ok(Self) if the field was successfully selected and pushed.
• Err(ReflectError) if the current frame is not a struct or an enum with a selected variant, or if the field doesn’t exist.

pub fn put<'val, T: Facet + 'val>(self, t: T) -> Result<Wip<'val>, ReflectError>

where 'a: 'val,

Puts a value of type T into the current frame.

Arguments

• t - The value to put into the frame.

Returns

• Ok(Self) if the value was successfully put into the frame.
• Err(ReflectError) if there was an error putting the value into the frame.

pub fn parse(self, s: &str) -> Result<Self, ReflectError>

Tries to parse the current frame’s value from a string

pub fn put_default(self) -> Result<Self, ReflectError>

Puts the default value in the currrent frame.

pub fn element_shape(&self) -> Result<&'static Shape, ReflectError>

Returns the shape of the element type for a list/array

pub fn key_shape(&self) -> Result<&'static Shape, ReflectError>

Returns the shape of the key type for a map

pub fn put_empty_list(self) -> Result<Self, ReflectError>

Creates an empty list without pushing any elements

pub fn put_empty_map(self) -> Result<Self, ReflectError>

Creates an empty map without pushing any entries

pub fn begin_pushback(self) -> Result<Self, ReflectError>

Begins pushback mode for a list/array, allowing elements to be added one by one

pub fn begin_map_insert(self) -> Result<Self, ReflectError>

Begins insertion mode for a map, allowing key-value pairs to be added one by one

pub fn push(self) -> Result<Self, ReflectError>

Pushes a new element onto the list/array

This creates a new frame for the element. When this frame is popped, the element will be added to the list.

pub fn push_some(self) -> Result<Self, ReflectError>

Prepare to push an option

pub fn pop_some_push_none(self) -> Result<Self, ReflectError>

Pops a not-yet-initialized option frame, setting it to None in the parent

This is used to set an option to None instead of Some. Steps:

1. Asserts the option frame is NOT initialized
2. Frees the memory for the pushed value
3. Pops the frame
4. Sets the parent option to its default value (i.e., None)
5. Pops the parent option (which is the actual Option<T>, but no longer in option mode)

pub fn push_map_key(self) -> Result<Self, ReflectError>

Pushes a new key frame for a map entry

This creates a new frame for the key. After setting the key value, call push_map_value to create a frame for the corresponding value.

pub fn push_map_value(self) -> Result<Self, ReflectError>

Pushes a new value frame for a map entry

This should be called after pushing and initializing a key frame. When the value frame is popped, the key-value pair will be added to the map.

pub fn pop(self) -> Result<Self, ReflectError>

Pops the current frame — goes back up one level

pub fn evict_tree(&mut self, frame: Frame) -> Frame

Evict a frame from istates, along with all its children (because we’re about to use drop_in_place on it — not yet though, we need to know the variant for enums, etc.)

pub fn path(&self) -> String

Returns the current path in the JSON document as a string. For example: “$.users[0].name”

Trait Implementations

impl Drop for Wip<'_>

fn drop(&mut self)

Executes the destructor for this type.