Skip to main content

OutputRootConfig

Struct OutputRootConfig 

Source
pub struct OutputRootConfig {
    pub root_dir: PathBuf,
    pub per_entity_subtree: bool,
    pub entity_code: Option<String>,
}
Expand description

Output routing config for the enhanced orchestrator’s file-writer.

In single-entity mode (default) OutputRootConfig::flat preserves the pre-v5.0 layout: all generated files land directly under root_dir.

In group-audit shard mode, the runner sets per_entity_subtree: true and entity_code: Some(code) so each entity’s archive is written under {root_dir}/entities/{code}/, leaving {root_dir}/ itself available for group-wide artifacts (consolidated FS, aggregate summary, etc).

Fields§

§root_dir: PathBuf

Root output directory as configured by the caller.

§per_entity_subtree: bool

When true, output is routed under {root_dir}/entities/{entity_code}/ so group-wide artifacts (consolidated FS, summary) can live alongside per-entity shard archives at {root_dir}/.

§entity_code: Option<String>

Entity code identifying the shard. Ignored when per_entity_subtree is false. When per_entity_subtree is true but this is None, OutputRootConfig::effective_dir safely falls back to root_dir.

Implementations§

Source§

impl OutputRootConfig

Source

pub fn flat(root_dir: impl Into<PathBuf>) -> Self

Flat single-entity layout: files written directly under root_dir.

Source

pub fn per_entity( root_dir: impl Into<PathBuf>, entity_code: impl Into<String>, ) -> Self

Per-entity subtree layout: files written under {root_dir}/entities/{entity_code}/.

Source

pub fn effective_dir(&self) -> PathBuf

Resolve the effective output_dir path for the file-writer. This is the directory into which all the existing write_* helpers compose their .join("subdir") paths.

Defensive fallback: if per_entity_subtree is true but entity_code is None, we revert to root_dir rather than write into a nameless {root_dir}/entities/ directory.

Source

pub fn root_path(&self) -> &Path

Root directory borrowed as a &Path — useful for group-wide artifacts (consolidated FS, aggregate summary) that must sit alongside the per-entity subtrees rather than inside one of them.

Trait Implementations§

Source§

impl Clone for OutputRootConfig

Source§

fn clone(&self) -> OutputRootConfig

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 OutputRootConfig

Source§

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

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

impl Default for OutputRootConfig

Source§

fn default() -> Self

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

impl PartialEq for OutputRootConfig

Source§

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

Source§

impl StructuralPartialEq for OutputRootConfig

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,