Skip to main content

ResponseFixture

Struct ResponseFixture 

Source
pub struct ResponseFixture<'a> { /* private fields */ }
Expand description

Provider-neutral response body plus optional interpreted metadata.

Implementations§

Source§

impl<'a> ResponseFixture<'a>

Source

pub const fn success(body: FixtureBody<'a>) -> Self

Creates a 200 OK response.

Source

pub const fn success_at( status: StatusCode, body: FixtureBody<'a>, ) -> Result<Self, ResponseFixtureError>

Creates a success response with an exact provider-owned 2xx status.

Source

pub const fn paginated( body: FixtureBody<'a>, pagination: PaginationFixture, ) -> Self

Creates a 200 OK paginated response.

Source

pub const fn action(body: FixtureBody<'a>, action: ActionFixture) -> Self

Creates a 200 OK action response.

Source

pub const fn rate_limited( body: FixtureBody<'a>, rate_limit: RateLimitFixture, ) -> Self

Creates a 429 Too Many Requests response.

Source

pub const fn with_rate_limit(self, rate_limit: RateLimitFixture) -> Self

Adds rate-limit metadata to any response fixture.

Source

pub const fn with_content_type(self, content_type: &'a str) -> Self

Adds one raw response content type for transport-boundary modeling.

Source

pub fn with_headers(self, headers: ResponseHeaders<'a>) -> Self

Adds complete prevalidated response-header metadata.

Source

pub const fn error( status: StatusCode, body: FixtureBody<'a>, ) -> Result<Self, ResponseFixtureError>

Creates a client or server error response.

Source

pub const fn kind(&self) -> FixtureKind

Returns the fixture category.

Source

pub const fn status(&self) -> StatusCode

Returns the response status.

Source

pub const fn body(&self) -> FixtureBody<'a>

Returns the response body source.

Source

pub const fn pagination(&self) -> Option<PaginationFixture>

Returns pagination metadata when present.

Source

pub const fn action_metadata(&self) -> Option<ActionFixture>

Returns action metadata when present.

Source

pub const fn rate_limit(&self) -> Option<RateLimitFixture>

Returns rate-limit metadata when present.

Source

pub const fn content_type(&self) -> Option<&'a str>

Returns the response content type when configured.

Source

pub const fn headers(&self) -> Option<&ResponseHeaders<'a>>

Returns complete prevalidated response-header metadata.

Trait Implementations§

Source§

impl<'a> Debug for ResponseFixture<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for ResponseFixture<'a>

§

impl<'a> Freeze for ResponseFixture<'a>

§

impl<'a> RefUnwindSafe for ResponseFixture<'a>

§

impl<'a> Send for ResponseFixture<'a>

§

impl<'a> Sync for ResponseFixture<'a>

§

impl<'a> Unpin for ResponseFixture<'a>

§

impl<'a> UnsafeUnpin for ResponseFixture<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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 T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.