Skip to main content

BytesRepr

Enum BytesRepr 

Source
#[non_exhaustive]
pub enum BytesRepr { Vec, Bytes, Custom(String), }
Expand description

The Rust type a proto bytes field maps to in generated owned structs.

The default is Vec (Vec<u8>). Bytes uses bytes::Bytes, which decodes zero-copy from a Bytes-backed buffer. Custom substitutes any type named by its fully-qualified Rust path that satisfies the buffa::ProtoBytes bound; the downstream crate must itself depend on the providing crate.

Select a representation through buffa_build’s bytes_type / bytes_type_custom builder methods (or the legacy use_bytes_type, which selects Bytes). The wire format is identical regardless of representation; view types keep borrowing &[u8], and map bytes values follow the same rules as the string path.

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.
§

Vec

::buffa::alloc::vec::Vec<u8> — growable and mutable (the default).

§

Bytes

::buffa::bytes::Bytes — reference-counted, immutable, decodes zero-copy from a Bytes-backed buffer.

§

Custom(String)

A custom type named by its fully-qualified Rust path. Must satisfy buffa::ProtoBytes and be provided by a crate the downstream depends on.

§Limitations

  • A foreign custom type used as a repeated element fails to compile (the emitted ReflectElement / ProtoElemJson impls violate the orphan rule). Wrap it in a crate-local newtype for that case; singular / optional / oneof uses work with a foreign type directly.
  • A Custom rule does not apply to map<K, bytes> values — they stay Vec<u8>. Only the built-in Bytes applies to map values.
  • A path that does not parse as a Rust type surfaces as CodeGenError::InvalidTypePath at generation (.compile()) time.
  • The per-element impls are deduplicated within a single generation, but the same crate-local type used as a repeated element across two separate compile() invocations in one crate emits the impl twice (a duplicate-impl E0119). Generate from a single compile(), or use distinct element types.

Trait Implementations§

Source§

impl Clone for BytesRepr

Source§

fn clone(&self) -> BytesRepr

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 BytesRepr

Source§

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

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

impl Default for BytesRepr

Source§

fn default() -> BytesRepr

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

impl Eq for BytesRepr

Source§

impl PartialEq for BytesRepr

Source§

fn eq(&self, other: &BytesRepr) -> 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 BytesRepr

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.