Struct Query 

pub struct Query<QB> { /* private fields */ }

Struct representing a SQL-like query for QuickBooks entities

Implementations

impl<QB: QBItem> Query<QB>

pub fn new() -> Self

Create a new empty query

pub unsafe fn condition(self, condition: WhereClause) -> Self

Add a condition to the query

Safety

This function is unsafe because it accepts a raw WhereClause. The caller must ensure that the WhereClause is valid and corresponds to the QuickBooks entity.

pub fn typed_condition(self, condition: TypedWhereClause<QB>) -> Self

Add a typed condition to the query

This is safe because the typed where clause ensures that the field and values are valid for the QuickBooks entity.

pub unsafe fn order(self, field: &'static str, order: Order) -> Self

Add an order clause to the query

Safety

This function is unsafe because it accepts a raw string slice as the field name. The caller must ensure that the field name is valid and corresponds to a field in the QuickBooks entity.

pub fn limit(self, number: u32, offset: Option<u32>) -> Self

Set a limit on the number of results returned by the query

pub fn query_string(&self) -> String

Generate the query string

pub fn execute( &self, qb: &QBContext, client: &Agent, ) -> Result<Vec<QB>, APIError>

Execute the query against the QuickBooks API, returning a vector of results or an error

Errors

This function will return an error if the API request fails or if the response cannot be parsed.

Trait Implementations

impl<QB: Clone> Clone for Query<QB>

fn clone(&self) -> Query<QB>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<QB: Debug> Debug for Query<QB>

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

Formats the value using the given formatter.

impl<QB: QBItem> Default for Query<QB>

fn default() -> Self

Returns the “default value” for a type.

impl<QB: QBItem> Display for Query<QB>

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

Formats the value using the given formatter.

impl<QB: PartialEq> PartialEq for Query<QB>

fn eq(&self, other: &Query<QB>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<QB> StructuralPartialEq for Query<QB>