Skip to main content

WorkpaperGenerator

Struct WorkpaperGenerator 

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

Generator for audit workpapers.

Implementations§

Source§

impl WorkpaperGenerator

Source

pub fn new(seed: u64) -> Self

Create a new generator with the given seed.

Source

pub fn with_config(seed: u64, config: WorkpaperGeneratorConfig) -> Self

Create a new generator with custom configuration.

Source

pub fn set_schema_configs( &mut self, workpapers: &WorkpaperConfig, review: &ReviewWorkflowConfig, )

v3.3.2: override internal config from the user-facing audit schema configuration (WorkpaperConfig + ReviewWorkflowConfig).

Mapping:

  • WorkpaperConfig.average_per_phase → a range of ±50% around the configured average, clamped to ≥1. E.g. average=5workpapers_per_section = (3, 8).
  • ReviewWorkflowConfig.average_review_delay_days → a ±1-day band around the average used for both first and second review delays.

The sampling / ISA-reference / cross-reference flags on WorkpaperConfig are not currently mapped to the generator’s internal state — they’re used by downstream formatting logic and reserved for v3.4+ (where we add explicit ISA-reference annotations to generated workpaper titles).

Source

pub fn generate_workpapers_for_phase( &mut self, engagement: &AuditEngagement, phase: EngagementPhase, phase_date: NaiveDate, team_members: &[String], ) -> Vec<Workpaper>

Generate workpapers for an engagement phase.

Source

pub fn generate_workpaper( &mut self, engagement: &AuditEngagement, section: WorkpaperSection, base_date: NaiveDate, team_members: &[String], ) -> Workpaper

Generate a single workpaper.

Source

pub fn generate_workpaper_with_context( &mut self, engagement: &AuditEngagement, section: WorkpaperSection, base_date: NaiveDate, team_members: &[String], enrichment: &WorkpaperEnrichment, ) -> Workpaper

Generate a workpaper enriched with real financial data and risk context.

Produces the base workpaper via [generate_workpaper] and then enriches the title, objective, procedure, and scope fields using the provided WorkpaperEnrichment context.

Source

pub fn generate_complete_workpaper_set( &mut self, engagement: &AuditEngagement, team_members: &[String], ) -> Vec<Workpaper>

Generate all workpapers for a complete engagement.

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> 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, 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