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, and view types keep borrowing &[u8]. A rule that matches a map field applies to its bytes value. One map shape keeps Vec<u8> values whatever rule matches: a map whose string key is mapped to bytes by strict_utf8_mapping (utf8_validation = NONE on the key) and whose value is bytes.

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

  • Under generate_json (for a type not listed in json_policy_types), generate_reflection_vtable, or any reflection with message cleanup, a foreign custom type used as a repeated element fails to compile (the emitted ProtoElemJson / ReflectElement / InspectElement impls violate the orphan rule). Wrap it in a crate-local newtype, or set CodeGenConfig::emit_custom_type_impls to false when the defining crate supplies those integrations. Singular / optional / oneof uses work with a foreign type directly.
  • A Custom rule applies to map<K, bytes> values, as Bytes does, with the same element impls and the same crate-local requirement.
  • A type listed in json_policy_types gets no ProtoElemJson impl: its repeated elements and map values go through buffa’s policy helpers, so with JSON alone it may be defined, together with its ProtoBytes and ProtoBytesJson impls, in another crate. Vtable reflection still emits ReflectElement, and reflection with message cleanup InspectElement, for it.
  • A type that is not a type path like crate::Name (for example _, () or &'static [u8]) surfaces as CodeGenError::InvalidTypePath at generation (.compile()) time. Associated type projections and parenthesized type paths are supported.
  • The per-element impls are deduplicated within a single generation, but the same crate-local type used as a repeated element or map value across two separate compile() invocations in one crate emits the impl twice (a duplicate-impl E0119), unless neither run emits one: the type is listed in json_policy_types and the runs generate no vtable reflection and no reflection with message cleanup. Otherwise generate from a single compile(), use distinct element types, or disable generated integrations and provide them once in the defining crate.

Trait Implementations§

Source§

impl Clone for BytesRepr

Source§

fn clone(&self) -> Self

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() -> Self

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

impl Eq for BytesRepr

Source§

impl PartialEq for BytesRepr

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.