Struct tonic_types::ErrorDetails

#[non_exhaustive]
pub struct ErrorDetails { /* private fields */ }

Groups the standard error messages structs. Provides associated functions and methods to setup and edit each error message independently. Used when extracting error details from tonic::Status, and when creating a tonic::Status with error details.

Implementations

impl ErrorDetails

pub fn new() -> Self

Generates an ErrorDetails struct with all fields set to None.

Examples

use tonic_types::{ErrorDetails};

let err_details = ErrorDetails::new();

pub fn with_bad_request(field_violations: Vec<FieldViolation>) -> Self

Generates an ErrorDetails struct with BadRequest details and remaining fields set to None.

Examples

use tonic_types::{ErrorDetails, FieldViolation};

let err_details = ErrorDetails::with_bad_request(vec![
    FieldViolation::new("field_1", "description 1"),
    FieldViolation::new("field_2", "description 2"),
]);

pub fn with_bad_request_violation(
    field: impl Into<String>,
    description: impl Into<String>
) -> Self

Generates an ErrorDetails struct with BadRequest details (one FieldViolation set) and remaining fields set to None.

Examples

use tonic_types::{ErrorDetails};

let err_details = ErrorDetails::with_bad_request_violation(
    "field",
    "description",
);

pub fn bad_request(&self) -> Option<BadRequest>

Get BadRequest details, if any

pub fn set_bad_request(&mut self, violations: Vec<FieldViolation>) -> &mut Self

Set BadRequest details. Can be chained with other .set_ and .add_ ErrorDetails methods.

Examples

use tonic_types::{ErrorDetails, FieldViolation};

let mut err_details = ErrorDetails::new();

err_details.set_bad_request(vec![
    FieldViolation::new("field_1", "description 1"),
    FieldViolation::new("field_2", "description 2"),
]);

pub fn add_bad_request_violation(
    &mut self,
    field: impl Into<String>,
    description: impl Into<String>
) -> &mut Self

Adds a FieldViolation to BadRequest details. Sets BadRequest details if it is not set yet. Can be chained with other .set_ and .add_ ErrorDetails methods.

Examples

use tonic_types::{ErrorDetails};

let mut err_details = ErrorDetails::new();

err_details.add_bad_request_violation("field", "description");

pub fn has_bad_request_violations(&self) -> bool

Returns true if BadRequest is set and its field_violations vector is not empty, otherwise returns false.

Examples

use tonic_types::{ErrorDetails};

let mut err_details = ErrorDetails::with_bad_request(vec![]);

assert_eq!(err_details.has_bad_request_violations(), false);

err_details.add_bad_request_violation("field", "description");

assert_eq!(err_details.has_bad_request_violations(), true);

Trait Implementations

impl Clone for ErrorDetails

fn clone(&self) -> ErrorDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorDetails

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

Formats the value using the given formatter.