Skip to main content

SharedCorpusContext

Struct SharedCorpusContext 

Source
pub struct SharedCorpusContext { /* private fields */ }
Expand description

The corpus-wide state CodeGenContext derives on every generate() call — which oneof variants are unboxed, which message fields are stored inline, and the raw comment text per fully-qualified name — none of which depends on the extern paths that legitimately vary per call in a one-crate-per-package workspace. Build one with SharedCorpusContext::new from the whole corpus and set CodeGenConfig::shared_corpus_context on every per-package config to skip that work on each call.

A context is only valid for the exact files and the same unboxed_oneof_fields/pointer_fields it was built from; generate checks both and returns CodeGenError::SharedCorpusContextMismatch rather than emitting code resolved against a different corpus. The context holds the corpus comment map for as long as any clone of it lives, so drop it once code generation is done. Cloning shares the precomputed state (Arcs inside), and the type is Send + Sync, so one context can be handed to parallel per-package generate() calls.

§Examples

use buffa_codegen::{CodeGenConfig, SharedCorpusContext};
let base = CodeGenConfig::default();
let shared = SharedCorpusContext::new(&corpus, &base);
for (extern_prefix, files_to_generate) in packages {
    let mut config = base.clone();
    config.extern_paths.push((extern_prefix, "::other_crate".to_string()));
    config.shared_corpus_context = Some(shared.clone());
    let _files = buffa_codegen::generate(&corpus, &files_to_generate, &config)?;
}

Implementations§

Source§

impl SharedCorpusContext

Source

pub fn new(files: &[FileDescriptorProto], config: &CodeGenConfig) -> Self

Precompute the corpus-wide state for files under config’s oneof and pointer-representation rules, for reuse across every generate() call that passes the same files and rules (see CodeGenConfig::shared_corpus_context).

Trait Implementations§

Source§

impl Clone for SharedCorpusContext

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 SharedCorpusContext

Source§

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

Formats the value using the given formatter. Read more

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.