Skip to main content

rust_ynab/
lib.rs

1//! A Rust client for the [YNAB API](https://api.ynab.com).
2//!
3//! # Quick Start
4//!
5//! ```rust,no_run
6//! use rust_ynab::{Client, PlanId};
7//!
8//! #[tokio::main]
9//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
10//!     let client = Client::new(&std::env::var("YNAB_TOKEN")?)?;
11//!     let plans = client.get_plans().include_accounts().send().await?;
12//!     for plan in plans {
13//!         println!("{}", plan.name);
14//!     }
15//!     Ok(())
16//! }
17//! ```
18
19mod display;
20mod ynab;
21
22pub use display::print_transaction_table;
23pub use ynab::account::{Account, AccountType, SaveAccount, SaveAccountType};
24pub use ynab::category::{
25    Category, CategoryGroup, GoalType, NewCategory, SaveCategory, SaveCategoryGroup,
26    SaveMonthCategory,
27};
28pub use ynab::client::Client;
29pub use ynab::common::{CurrencyFormat, DateFormat};
30pub use ynab::errors::{ApiError, Error};
31pub use ynab::month::Month;
32pub use ynab::movements::{MoneyMovement, MoneyMovementGroup};
33pub use ynab::payee::{Payee, PayeeLocation, PostPayee, SavePayee};
34pub use ynab::plan::{Plan, PlanId, PlanSettings};
35pub use ynab::transaction::{
36    ClearedStatus, ExistingTransaction, FlagColor, Frequency, NewTransaction,
37    SaveScheduledTransaction, SaveSubTransaction, SaveTransactionWithIdOrImportId,
38    SaveTransactionsResponse, ScheduledSubtransaction, ScheduledTransaction, Subtransaction,
39    Transaction, TransactionType,
40};
41pub use ynab::user::User;
42
43/// Converts a YNAB milliunit amount to a dollar amount.
44///
45/// # Examples
46///
47/// ```
48/// assert_eq!(rust_ynab::milliunits_to_amount(50000), 50.0);
49/// assert_eq!(rust_ynab::milliunits_to_amount(-1500), -1.5);
50/// ```
51pub fn milliunits_to_amount(milliunits: i64) -> f64 {
52    milliunits as f64 / 1000.0
53}