Struct APIError 

pub struct APIError(/* private fields */);

The main error type for all QuickBooks API operations.

APIError is a wrapper around APIErrorInner that provides a consistent error interface for all operations in the library. It implements standard error traits and can be converted from various underlying error types.

Examples

use quick_oxibooks::error::APIError;
use quick_oxibooks::{QBContext, Environment};
use ureq::Agent;

fn create_context() -> Result<QBContext, APIError> {
    let client = Agent::new_with_defaults();
    QBContext::new_from_env(Environment::SANDBOX, &client)
}

let _ = match create_context() {
    Ok(_context) => { println!("Context created successfully"); Ok(()) }
    Err(e) => { eprintln!("Error: {}", e); Err(e) }
};

Error Conversion

Many error types automatically convert to APIError:

• Network errors from ureq
• JSON parsing errors from serde_json
• QuickBooks-specific validation errors
• Environment variable errors

Error Handling Patterns

use quick_oxibooks::error::{APIError, APIErrorInner};
use quick_oxibooks::functions::create::QBCreate;
use quickbooks_types::{Customer, QBItem};

fn handle_customer_creation(customer: &Customer, qb_context: &quick_oxibooks::QBContext, client: &ureq::Agent) {
    match customer.create(qb_context, client) {
        Ok(created) => println!("Created: {:?}", created.id()),
        Err(e) => {
            match &*e {
                APIErrorInner::CreateMissingItems => {
                    eprintln!("Customer missing required fields");
                }
                APIErrorInner::BadRequest(_qb_error) => {
                    eprintln!("QuickBooks rejected the request");
                }
                _ => eprintln!("Other error: {}", e),
            }
        }
    }
}

Trait Implementations

impl Debug for APIError

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

Formats the value using the given formatter.

impl Deref for APIError

type Target = APIErrorInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for APIError

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

Formats the value using the given formatter.

impl Error for APIError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<T> From<T> for APIError

where T: Into<APIErrorInner>,

fn from(err: T) -> Self

Converts to this type from the input type.

impl Serialize for APIError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.