pub struct ResponseFixture<'a> { /* private fields */ }Expand description
Provider-neutral response body plus optional interpreted metadata.
Implementations§
Source§impl<'a> ResponseFixture<'a>
impl<'a> ResponseFixture<'a>
Sourcepub const fn success(body: FixtureBody<'a>) -> Self
pub const fn success(body: FixtureBody<'a>) -> Self
Creates a 200 OK response.
Sourcepub const fn success_at(
status: StatusCode,
body: FixtureBody<'a>,
) -> Result<Self, ResponseFixtureError>
pub const fn success_at( status: StatusCode, body: FixtureBody<'a>, ) -> Result<Self, ResponseFixtureError>
Creates a success response with an exact provider-owned 2xx status.
Sourcepub const fn paginated(
body: FixtureBody<'a>,
pagination: PaginationFixture,
) -> Self
pub const fn paginated( body: FixtureBody<'a>, pagination: PaginationFixture, ) -> Self
Creates a 200 OK paginated response.
Sourcepub const fn action(body: FixtureBody<'a>, action: ActionFixture) -> Self
pub const fn action(body: FixtureBody<'a>, action: ActionFixture) -> Self
Creates a 200 OK action response.
Sourcepub const fn rate_limited(
body: FixtureBody<'a>,
rate_limit: RateLimitFixture,
) -> Self
pub const fn rate_limited( body: FixtureBody<'a>, rate_limit: RateLimitFixture, ) -> Self
Creates a 429 Too Many Requests response.
Sourcepub const fn with_rate_limit(self, rate_limit: RateLimitFixture) -> Self
pub const fn with_rate_limit(self, rate_limit: RateLimitFixture) -> Self
Adds rate-limit metadata to any response fixture.
Sourcepub const fn with_content_type(self, content_type: &'a str) -> Self
pub const fn with_content_type(self, content_type: &'a str) -> Self
Adds one raw response content type for transport-boundary modeling.
Sourcepub fn with_headers(self, headers: ResponseHeaders<'a>) -> Self
pub fn with_headers(self, headers: ResponseHeaders<'a>) -> Self
Adds complete prevalidated response-header metadata.
Sourcepub const fn error(
status: StatusCode,
body: FixtureBody<'a>,
) -> Result<Self, ResponseFixtureError>
pub const fn error( status: StatusCode, body: FixtureBody<'a>, ) -> Result<Self, ResponseFixtureError>
Creates a client or server error response.
Sourcepub const fn kind(&self) -> FixtureKind
pub const fn kind(&self) -> FixtureKind
Returns the fixture category.
Sourcepub const fn status(&self) -> StatusCode
pub const fn status(&self) -> StatusCode
Returns the response status.
Sourcepub const fn body(&self) -> FixtureBody<'a>
pub const fn body(&self) -> FixtureBody<'a>
Returns the response body source.
Sourcepub const fn pagination(&self) -> Option<PaginationFixture>
pub const fn pagination(&self) -> Option<PaginationFixture>
Returns pagination metadata when present.
Sourcepub const fn action_metadata(&self) -> Option<ActionFixture>
pub const fn action_metadata(&self) -> Option<ActionFixture>
Returns action metadata when present.
Sourcepub const fn rate_limit(&self) -> Option<RateLimitFixture>
pub const fn rate_limit(&self) -> Option<RateLimitFixture>
Returns rate-limit metadata when present.
Sourcepub const fn content_type(&self) -> Option<&'a str>
pub const fn content_type(&self) -> Option<&'a str>
Returns the response content type when configured.
Sourcepub const fn headers(&self) -> Option<&ResponseHeaders<'a>>
pub const fn headers(&self) -> Option<&ResponseHeaders<'a>>
Returns complete prevalidated response-header metadata.