Struct ValidInput 

pub struct ValidInput { /* private fields */ }

Input which has been validated and is ready for processing. Controls which language to use, the month for which to generate the invoice, the items to be invoiced, the layout of the invoice, and an optional output path for the generated PDF file.

Implementations

impl ValidInput

pub fn builder() -> ValidInputBuilder

Create an instance of ValidInput using the builder syntax

impl ValidInput

pub fn language(&self) -> &Language

The language to use for the invoice, used on labels, headers etc. Defaults to English (Language::EN).

pub fn period(&self) -> &YearMonthAndFortnight

The period for which to generate the invoice, this affects the invoice number as well as the invoice date and due date.

Note: We use the period type with the highest granularity, so that we always can convert it to a kind of period of more coarse granularity. For example, if the period is YearMonthAndFortnight, we can always convert it to YearAndMonth later in the flow if that matches the invoice cadence.

pub fn items(&self) -> &InvoicedItems

The items to be invoiced, either services or expenses.

pub fn layout(&self) -> &Layout

The layout of the invoice to use

pub fn maybe_output_path(&self) -> &Option<PathBuf>

An optional override of where to save the output PDF file.

pub fn email(&self) -> &Option<EmailSettings<SecretBox<str>>>

If set, the invoice will be sent via email after generation.

If set to true but email is not configured, an error will be thrown later.

Trait Implementations

impl Clone for ValidInput

fn clone(&self) -> ValidInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ValidInput

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

Formats the value using the given formatter.

impl Display for ValidInput

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

Formats the value using the given formatter.

impl HasSample for ValidInput

fn sample() -> ValidInput

Returns a sample instance of the type.

fn sample_other() -> ValidInput