Skip to main content

VenvConfig

Struct VenvConfig 

Source
pub struct VenvConfig {
    pub class_name: String,
    pub requirements_file: Option<String>,
    pub script_path: String,
    pub max_content_size: usize,
    pub timeout_secs: u64,
}
Expand description

Venv-relevant settings, parsed from a plugin entry’s opaque config map.

PluginConfig has no fields for a class name, a content-size cap, or a per-plugin timeout — those are host-specific, so they live in the free-form config value and are parsed here.

§plugin_dirs is deliberately absent

A plugin_dirs: key in this block is ignored; a top-level plugin_dirs: YAML key fails the config load. Plugin directories are not configurable: the host always uses <project root>/plugins, which is where cpex plugin install puts them. See DEFAULT_PLUGIN_DIR. Serde ignores unknown fields, so an existing config that still carries the key parses without error — the value simply has no effect.

Fields§

§class_name: String

Fully-qualified Python class implementing the plugin, e.g. my_pkg.filters.PiiFilter. Required: the worker needs it to import and instantiate the plugin, and the venv cache is keyed on it.

§requirements_file: Option<String>

Requirements file to install into the venv, relative to the package root. Optional — a plugin installed by FQN conversion gets its dependencies from the install channel, not a requirements file, and then the manifest version plus hash is the sole cache signal.

§script_path: String

Worker script path inside the venv. Defaults to the framework’s worker.py; overridable for tests and for a host that vendors its own.

§max_content_size: usize

Cap on one serialized outbound task, in bytes.

§timeout_secs: u64

Per-invocation timeout, in seconds. Falls back to the framework default when absent.

Implementations§

Source§

impl VenvConfig

Source

pub fn from_plugin_config( config: &PluginConfig, ) -> Result<Self, Box<PluginError>>

Parse the venv settings out of a plugin entry’s config map.

A missing or malformed class_name is a config error, not a panic — the engine surfaces it against the plugin name at load time.

Trait Implementations§

Source§

impl Clone for VenvConfig

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 VenvConfig

Source§

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

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

impl<'de> Deserialize<'de> for VenvConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more