Skip to main content

PointerRepr

Enum PointerRepr 

Source
#[non_exhaustive]
pub enum PointerRepr { Box, Custom(String), }
Expand description

The owned smart pointer a singular message field’s buffa::MessageField wraps in generated owned structs.

The default is Box. Custom substitutes any pointer that satisfies the buffa::ProtoBox<T> bound — for example a smallbox-style pointer that stores small messages inline. Because the pointer wraps the message type, its path is a template containing a * placeholder for the message type (e.g. "::smallbox::SmallBox<*, ::smallbox::space::S4>" or "::my_crate::SmallBox<*>").

Because buffa::ProtoBox is buffa-owned, a foreign pointer cannot implement it directly (orphan rule) — the template must name a crate-local newtype, mirroring the ProtoString newtype expectation.

Select a representation through buffa_build’s box_type_custom builder method. The wire format is identical regardless of the pointer; view types are unaffected. Applies to singular message fields and boxed oneof message/group variants (a variant opted into inline storage via unboxed_oneof_fields takes precedence and gets no pointer). Repeated message fields use a collection, not a pointer.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Box

::buffa::alloc::boxed::Box<T> (inside MessageField<T>) — the default. Keeps generated output byte-identical to a build without the knob (the MessageField pointer type parameter defaults to Box).

§

Custom(String)

A custom pointer named by a Rust type-path template with a * placeholder for the message type. Must satisfy buffa::ProtoBox<T> and be a crate-local newtype.

§Limitations

  • The template must contain at least one *; a template that omits it surfaces as CodeGenError::MissingWildcard, and one whose substitution does not parse as CodeGenError::InvalidTypePath, at generation (.compile()) time.
  • Rc / Arc and other shared/COW pointers are unusable: the decoder merges in place (needs DerefMut), so only an exclusively-owned pointer (heap Box, inline SmallBox) can implement ProtoBox.
  • An inline pointer inflates the parent struct per field, so select it per field/prefix, never as a blanket default.
  • On a boxed oneof variant under the arbitrary feature, the custom pointer must implement arbitrary::Arbitrary (the oneof enum derives it and stores the pointer directly in the variant). The singular-field path needs no such impl — MessageField constructs the pointer itself.

Trait Implementations§

Source§

impl Clone for PointerRepr

Source§

fn clone(&self) -> PointerRepr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PointerRepr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PointerRepr

Source§

fn default() -> PointerRepr

Returns the “default value” for a type. Read more
Source§

impl Eq for PointerRepr

Source§

impl PartialEq for PointerRepr

Source§

fn eq(&self, other: &PointerRepr) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PointerRepr

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.