Partial

Struct Partial 

Source
pub struct Partial<'facet> { /* private fields */ }
Expand description

A work-in-progress heap-allocated value

§Lifetimes

  • 'facet: The lifetime of borrowed values within the structure (or ’static if it’s owned)
  • 'shape: The lifetime of the Shape structure itself (often ’static)

Implementations§

Source§

impl<'facet> Partial<'facet>

Source

pub fn alloc_shape(shape: &'static Shape) -> Result<Self, ReflectError>

Allocates a new Partial instance with the given shape

Source

pub fn alloc<T>() -> Result<TypedPartial<'facet, T>, ReflectError>
where T: Facet<'facet>,

Allocates a new TypedPartial instance with the given shape and type

Source

pub fn from_ptr(data: PtrUninit<'_>, shape: &'static Shape) -> Self

Creates a Partial from an existing pointer and shape (used for nested initialization)

Source

pub fn frame_count(&self) -> usize

Returns the current frame count (depth of nesting)

Source

pub fn set<U>(&mut self, value: U) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Sets a value wholesale into the current frame

Source

pub unsafe fn set_shape( &mut self, src_value: PtrConst<'_>, src_shape: &'static Shape, ) -> Result<&mut Self, ReflectError>

Sets a value into the current frame by shape, for shape-based operations

If this returns Ok, then src_value has been moved out of

§Safety

The caller must ensure that src_value points to a valid instance of a value whose memory layout and type matches src_shape, and that this value can be safely copied (bitwise) into the destination specified by the Partial’s current frame. No automatic drop will be performed for any existing value, so calling this on an already-initialized destination may result in leaks or double drops if misused. After a successful call, the ownership of the value at src_value is effectively moved into the Partial (i.e., the destination), and the original value should not be used or dropped by the caller; consider using core::mem::forget on the passed value. If an error is returned, the destination remains unmodified and safe for future operations.

Source

pub fn set_default(&mut self) -> Result<&mut Self, ReflectError>

Sets the current frame to its default value

Source

pub fn set_field_default( &mut self, field_default_fn: DefaultInPlaceFn, ) -> Result<&mut Self, ReflectError>

Sets the current frame using a field-level default function

Source

pub fn set_from_function<F>(&mut self, f: F) -> Result<&mut Self, ReflectError>
where F: FnOnce(PtrUninit<'_>) -> Result<(), ReflectError>,

Sets the current frame using a function that initializes the value

Source

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

Parses a string value into the current frame using the type’s ParseFn from the vtable

Source

pub fn select_variant_named( &mut self, variant_name: &str, ) -> Result<&mut Self, ReflectError>

Pushes a variant for enum initialization by name

Source

pub fn select_variant( &mut self, discriminant: i64, ) -> Result<&mut Self, ReflectError>

Pushes a variant for enum initialization

Source

pub fn begin_field( &mut self, field_name: &str, ) -> Result<&mut Self, ReflectError>

Selects a field of a struct with a given name

Source

pub fn select_nth_variant( &mut self, index: usize, ) -> Result<&mut Self, ReflectError>

Selects a variant for enum initialization, by variant index in the enum’s variant list (0-based)

Source

pub fn begin_nth_field(&mut self, idx: usize) -> Result<&mut Self, ReflectError>

Selects the nth field of a struct by index

Source

pub fn begin_nth_element( &mut self, idx: usize, ) -> Result<&mut Self, ReflectError>

Selects the nth element of an array by index

Source

pub fn begin_nth_enum_field( &mut self, idx: usize, ) -> Result<&mut Self, ReflectError>

Selects the nth field of an enum variant by index

Source

pub fn begin_smart_ptr(&mut self) -> Result<&mut Self, ReflectError>

Pushes a frame to initialize the inner value of a smart pointer (Box<T>, Arc<T>, etc.)

Source

pub fn begin_list(&mut self) -> Result<&mut Self, ReflectError>

Initializes a list (Vec, etc.) if it hasn’t been initialized before. This is a prerequisite to begin_push_item/set/end or the shorthand push.

begin_list does not clear the list if it was previously initialized. begin_list does not push a new frame to the stack, and thus does not require end to be called afterwards.

Source

pub fn begin_map(&mut self) -> Result<&mut Self, ReflectError>

Begins a map initialization operation This initializes the map with default capacity and allows inserting key-value pairs

Source

pub fn begin_key(&mut self) -> Result<&mut Self, ReflectError>

Pushes a frame for the map key Automatically starts a new insert if we’re idle

Source

pub fn begin_value(&mut self) -> Result<&mut Self, ReflectError>

Pushes a frame for the map value Must be called after the key has been set and popped

Source

pub fn begin_list_item(&mut self) -> Result<&mut Self, ReflectError>

Pushes an element to the list The element should be set using set() or similar methods, then pop() to complete

Source

pub fn end(&mut self) -> Result<&mut Self, ReflectError>

Pops the current frame off the stack, indicating we’re done initializing the current field

Source

pub fn build(&mut self) -> Result<HeapValue<'facet>, ReflectError>

Builds the value

Source

pub fn path(&self) -> String

Returns a human-readable path representing the current traversal in the builder, e.g., RootStruct.fieldName[index].subfield.

Source

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

Returns the shape of the current frame.

Source

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

Returns the innermost shape (alias for shape(), for compatibility)

Source

pub fn is_field_set(&self, index: usize) -> Result<bool, ReflectError>

Check if a struct field at the given index has been set

Source

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

Find the index of a field by name in the current struct

Source

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

Get the currently selected variant for an enum

Source

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

Find a variant by name in the current enum

Source

pub fn begin_some(&mut self) -> Result<&mut Self, ReflectError>

Begin building the Some variant of an Option

Source

pub fn begin_inner(&mut self) -> Result<&mut Self, ReflectError>

Begin building the inner value of a wrapper type

Source

pub fn set_from_peek( &mut self, peek: &Peek<'_, '_>, ) -> Result<&mut Self, ReflectError>

Copy a value from a Peek into the current position (safe alternative to set_shape)

Source

pub fn set_field_from_default( &mut self, field_data: PtrConst<'_>, field_shape: &'static Shape, ) -> Result<&mut Self, ReflectError>

Copy a field from a struct’s default value (safe wrapper for deserialization) This method creates the Peek internally to avoid exposing unsafe code to callers

Source

pub fn fill_unset_fields_from_default( &mut self, ) -> Result<&mut Self, ReflectError>

Fill all unset fields from the struct’s default value This is a safe API for format deserializers that forbid unsafe code

Source

pub fn set_nth_element<U>( &mut self, idx: usize, value: U, ) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the nth element of an array directly to value, popping after.

Source

pub fn set_nth_field<U>( &mut self, idx: usize, value: U, ) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the field at index idx directly to value, popping after.

Source

pub fn set_field<U>( &mut self, field_name: &str, value: U, ) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the named field to value, popping after.

Source

pub fn set_nth_enum_field<U>( &mut self, idx: usize, value: U, ) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the nth field of an enum variant directly to value, popping after.

Source

pub fn set_key<U>(&mut self, value: U) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the key for a map key-value insertion, then pops after.

Source

pub fn set_value<U>(&mut self, value: U) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Convenience shortcut: sets the value for a map key-value insertion, then pops after.

Source

pub fn push<U>(&mut self, value: U) -> Result<&mut Self, ReflectError>
where U: Facet<'facet>,

Shorthand for: begin_list_item(), set, end

Trait Implementations§

Source§

impl<'facet> Drop for Partial<'facet>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'facet> Freeze for Partial<'facet>

§

impl<'facet> RefUnwindSafe for Partial<'facet>

§

impl<'facet> !Send for Partial<'facet>

§

impl<'facet> !Sync for Partial<'facet>

§

impl<'facet> Unpin for Partial<'facet>

§

impl<'facet> !UnwindSafe for Partial<'facet>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.