pub struct Builder { /* private fields */ }
Expand description

Builder for Error.

Implementations§

source§

impl Builder

source

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

Sets the error message.

source

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

Sets the error code.

source

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

Sets the request ID the error happened for.

source

pub fn custom(&mut self, key: &'static str, value: impl Into<String>) -> &mut Self

Set a custom field on the error metadata

Typically, these will be accessed with an extension trait:

use aws_smithy_types::Error;
const HOST_ID: &str = "host_id";
trait S3ErrorExt {
    fn extended_request_id(&self) -> Option<&str>;
}

impl S3ErrorExt for Error {
    fn extended_request_id(&self) -> Option<&str> {
        self.extra(HOST_ID)
    }
}

fn main() {
    // Extension trait must be brought into scope
    use S3ErrorExt;
    let sdk_response: Result<(), Error> = Err(Error::builder().custom(HOST_ID, "x-1234").build());
    if let Err(err) = sdk_response {
        println!("request id: {:?}, extended request id: {:?}", err.request_id(), err.extended_request_id());
    }
}
source

pub fn build(&mut self) -> Error

Creates the error.

Trait Implementations§

source§

impl Debug for Builder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Builder

source§

fn default() -> Builder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.