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
19pub mod display;
20mod ynab;
21
22pub use ynab::account::{Account, AccountType, SaveAccount, SaveAccountType};
23pub use ynab::category::{
24    Category, CategoryGroup, GoalType, NewCategory, SaveCategory, SaveCategoryGroup,
25    SaveMonthCategory,
26};
27pub use ynab::client::Client;
28pub use ynab::common::{CurrencyFormat, DateFormat};
29pub use ynab::errors::{ApiError, Error};
30pub use ynab::month::Month;
31pub use ynab::movements::{MoneyMovement, MoneyMovementGroup};
32pub use ynab::payee::{Payee, PayeeLocation, PostPayee, SavePayee};
33pub use ynab::plan::{Plan, PlanId, PlanSettings};
34pub use ynab::transaction::{
35    ClearedStatus, ExistingTransaction, FlagColor, Frequency, NewTransaction,
36    SaveScheduledTransaction, SaveSubTransaction, SaveTransactionWithIdOrImportId,
37    SaveTransactionsResponse, ScheduledSubtransaction, ScheduledTransaction, Subtransaction,
38    Transaction, TransactionType,
39};
40pub use ynab::user::User;
41
42/// Converts a YNAB milliunit amount to a dollar amount.
43///
44/// # Examples
45///
46/// ```
47/// assert_eq!(rust_ynab::milliunits_to_amount(50000), 50.0);
48/// assert_eq!(rust_ynab::milliunits_to_amount(-1500), -1.5);
49/// ```
50pub fn milliunits_to_amount(milliunits: i64) -> f64 {
51    milliunits as f64 / 1000.0
52}
rust_ynab/lib.rs

rust_ynab/
lib.rs
