Struct asciii::project::Project

pub struct Project { /* fields omitted */ }

Represents a Project.

A project is storable, contains products, and you can create an offer or invoice from it. The main implementation is done in spec.

Methods

impl Project

pub fn yaml(&self) -> &Yaml

Access to inner data

pub fn open<S: AsRef<OsStr> + ?Sized>(pathish: &S) -> Result<Project>

Opens a project from file path;

pub fn parse_yaml(&self) -> Result<Project>

import from yaml file

pub fn dump_yaml(&self) -> String

pub fn to_json(&self) -> Result<String>

export to JSON

pub fn from_file_content(content: &str) -> Result<Project>

Used mostly for testing purposes

pub fn field(&self, path: &str) -> Option<String>

wrapper around yaml::get() with replacement

pub fn client(&self) -> Client

Returns the struct Client, which abstracts away client specific stuff.

pub fn offer(&self) -> Offer

Returns the struct Offer, which abstracts away offer specific stuff.

pub fn invoice(&self) -> Invoice

Returns the struct Invoice, which abstracts away invoice specific stuff.

pub fn hours(&self) -> Hours

Returns the struct Invoice, which abstracts away invoice specific stuff.

pub fn is_ready_for_offer(&self) -> SpecResult

Ready to produce offer.

Ready to send an offer to the client.

pub fn is_ready_for_invoice(&self) -> SpecResult

Valid to produce invoice

Ready to send an invoice to the client.

pub fn is_ready_for_archive(&self) -> SpecResult

Completely done and in the past.

Ready to be **h:

pub fn to_csv(&self, bill_type: BillType) -> Result<String>

pub fn debug(&self) -> Debug

pub fn empty_fields(&self) -> Vec<String>

Check Templated for replacable markers

pub fn replace_field(&self, field: &str, value: &str) -> Result<()>

Fill certain field

pub fn our_bad(&self) -> Option<Duration>

Time between event and creation of invoice

pub fn their_bad(&self) -> Option<Duration>

Time between creation of invoice and payment

pub fn to_tasks(&self) -> Calendar

What I need to do

Produces an iCal calendar from this project.

Trait Implementations

impl Validatable for Project

fn validate(&self) -> SpecResult

Checks for certain errors

fn is_valid(&self) -> bool

Returns true if valid

fn errors(&self) -> Option<ErrorList>

Returns list of found errors

impl IsProject for Project

fn name(&self) -> Option<&str>

Project Name

fn event_date(&self) -> Option<Date<Utc>>

When was the event

fn format(&self) -> Option<Version>

Version of project format

fn canceled(&self) -> bool

Did the event actually occur

fn responsible(&self) -> Option<&str>

Who organized the event

fn long_desc(&self) -> String

Long description of the project

impl Redeemable for Project

fn payed_date(&self) -> Option<Date<Utc>>

When was the project payed

fn is_payed(&self) -> bool

If was the project payed

fn tax(&self) -> Option<Tax>

When what is the MWsT of the project.

fn bills(&self) -> ProductResult<(Bill<Product>, Bill<Product>)>

Returns a bill for the offer and one for the invoice.

fn sum_sold(&self) -> ProductResult<Currency>

Sum of sold products

impl HasEvents for Project

fn to_ical(&self) -> Calendar

Produces an iCal calendar from this project.

fn events(&self) -> Option<Vec<Event>>

Produces a list of DateRanges for the event.

fn times(&self, yaml: &Yaml) -> Option<Vec<EventTime>>

Returns a list of Events

fn location(&self) -> Option<&str>

Returns the location of the event

impl ExportTarget<Client> for Project

fn export(&self) -> Client

impl ExportTarget<Event> for Project

fn export(&self) -> Event

impl ExportTarget<Service> for Project

fn export(&self) -> Service

impl ExportTarget<Offer> for Project

fn export(&self) -> Offer

impl ExportTarget<Invoice> for Project

fn export(&self) -> Invoice

impl ExportTarget<Bills> for Project

fn export(&self) -> Bills

impl ExportTarget<Complete> for Project

fn export(&self) -> Complete

impl ExportTarget<Checks> for Project

fn export(&self) -> Checks

impl ExportTarget<Errors> for Project

fn export(&self) -> Errors

impl ExportTarget<Extras> for Project

fn export(&self) -> Extras

impl Exportable for Project

fn export_dir(&self) -> PathBuf

Where to export to

fn offer_file_name(&self, extension: &str) -> Option<String>

Filename of the offer output file.

fn invoice_file_name(&self, extension: &str) -> Option<String>

Filename of the invoice output file. Carefull! uses today's date.

fn output_file_exists(&self, bill_type: &BillType) -> bool

fn output_file(&self, bill_type: &BillType) -> Option<PathBuf>

fn offer_file(&self) -> Option<PathBuf>

fn invoice_file(&self) -> Option<PathBuf>

fn offer_file_exists(&self) -> bool

fn invoice_file_exists(&self) -> bool

fn write_to_path<P: AsRef<OsStr> + Debug>(     content: &str,     target: &P ) -> Result<()>

fn full_file_path(&self, bill_type: &BillType, ext: &str) -> Result<PathBuf>

fn full_offer_file_path(&self, ext: &str) -> Result<PathBuf>

fn full_invoice_file_path(&self, ext: &str) -> Result<PathBuf>

fn write_to_file(     &self,     content: &str,     bill_type: &BillType,     ext: &str ) -> Result<PathBuf>

fn write_to_offer_file(&self, content: &str, ext: &str) -> Result<PathBuf>

fn write_to_invoice_file(&self, content: &str, ext: &str) -> Result<PathBuf>

impl Storable for Project

fn file_extension() -> String

Main Projectfile extension

fn from_template(     project_name: &str,     template: &Path,     fill: &HashMap<&str, String> ) -> StorageResult<StorableAndTempDir<Self>>

creates in tempfile

fn prefix(&self) -> Option<String>

For archiving

fn index(&self) -> Option<String>

For sorting

fn short_desc(&self) -> String

fn modified_date(&self) -> Option<Date<Utc>>

fn file(&self) -> PathBuf

Path to project file

fn set_file(&mut self, new_file: &Path)

Sets the project File

fn set_git_status(&mut self, status: GitStatus)

Tell a project its own git status after opening

fn get_git_status(&self) -> GitStatus

Ask a project for its gitstatus

fn open_folder(folder_path: &Path) -> StorageResult<Project>

Opens a yaml and parses it.

fn open_file(file_path: &Path) -> StorageResult<Project>

fn matches_filter(&self, key: &str, val: &str) -> bool

Checks against a certain key-val pair.

fn matches_search(&self, term: &str) -> bool

UNIMPLEMENTED: Checks against a certain search term.

TODO compare agains InvoiceNumber, ClientFullName, Email, event/name, invoice/official Etc

fn is_ready_for_archive(&self) -> bool

fn ident(&self) -> String

For file names

fn year(&self) -> Option<i32>

fn delete_project_dir_if(     &self,     confirmed: impl Fn() -> bool ) -> Result<()>

Deletes the project if the passed in closure returns true

fn file_name(&self) -> String

Filename as fallback

fn dir(&self) -> FolderPathBuf

Path to project folder

impl<'a> From<&'a Project> for Debug

fn from(project: &'a Project) -> Debug

Performs the conversion.

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.