Struct BulkResponse 

pub struct BulkResponse<T> {
    pub results: Vec<BulkItemResult<T>>,
}

The response to a BulkRequest, containing per-item results.

Fields

results: Vec<BulkItemResult<T>>

Per-item outcomes, in the same order as BulkRequest::items.

Implementations

impl<T> BulkResponse<T>

pub fn succeeded_count(&self) -> usize

Returns the number of successfully processed items.

Examples

use api_bones::bulk::{BulkResponse, BulkItemResult};

let response: BulkResponse<i32> = BulkResponse {
    results: vec![
        BulkItemResult::Success { data: 1 },
        BulkItemResult::Success { data: 2 },
    ],
};
assert_eq!(response.succeeded_count(), 2);

pub fn failed_count(&self) -> usize

Returns the number of items that failed to process.

Examples

use api_bones::bulk::{BulkResponse, BulkItemResult};
use api_bones::ApiError;

let response: BulkResponse<i32> = BulkResponse {
    results: vec![
        BulkItemResult::Failure { index: 0, error: Box::new(ApiError::not_found("gone")) },
    ],
};
assert_eq!(response.failed_count(), 1);

pub fn has_failures(&self) -> bool

Returns true if at least one item failed.

Examples

use api_bones::bulk::{BulkResponse, BulkItemResult};
use api_bones::ApiError;

let response: BulkResponse<i32> = BulkResponse {
    results: vec![
        BulkItemResult::Success { data: 1 },
        BulkItemResult::Failure { index: 1, error: Box::new(ApiError::not_found("nope")) },
    ],
};
assert!(response.has_failures());

Trait Implementations

impl<T: Clone> Clone for BulkResponse<T>

fn clone(&self) -> BulkResponse<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BulkResponse<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for BulkResponse<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for BulkResponse<T>

fn eq(&self, other: &BulkResponse<T>) -> 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<T> Serialize for BulkResponse<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for BulkResponse<T>