#[non_exhaustive]pub enum ResponseBody {
Download {
path: PathBuf,
filename: String,
},
Preview {
path: PathBuf,
},
Redirect {
url: String,
},
Raw {
body: String,
content_type: String,
},
}Expand description
Action 的特殊业务响应体:文件下载、文件预览、重定向、原始响应体。
Action 将本类型作为 type Output 返回时,派发边界
(DynAction::dispatch)会识别并把它转为
ApiResponse::attachment,普通输出的 JSON 线格式不受影响。
标注 #[non_exhaustive]:未来新增变体不再构成破坏性变更,下游穷尽 match
请保留通配臂。
§示例
use yang_base::action::ResponseBody;
async fn index(&self, ctx: ActionContext, input: Self::Input) -> Result<Self::Output, BaseError> {
// 文件下载
Ok(ResponseBody::download("/data/report.pdf", "report.pdf"))
// 文件预览
// Ok(ResponseBody::preview("/data/a.png"))
// 重定向
// Ok(ResponseBody::redirect("https://example.com/next"))
// 原始 JSON 响应体(不套 ApiResponse 包络)
// ResponseBody::raw(r#"{"code":0,"msg":"ok"}"#, "application/json")
}Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Download
文件下载:传输层以 Content-Disposition: attachment 返回文件字节。
Preview
文件预览:传输层以 Content-Disposition: inline 返回文件字节。
Redirect
重定向:传输层返回 302 状态码与 Location 头。
Raw
原始响应体:传输层直接以 content_type 返回 body,不套 ApiResponse 包络。
供外部系统要求固定响应形状(顶层键名、层级与框架包络不一致)时使用。
content_type 只允许 application/json;body 必须是该类型下的完整响应文本。
请优先用 ResponseBody::raw 构造,它会校验 content_type;派发边界
wrap_dispatch_output 会对直接构造的本变体再执行同一白名单校验。
Implementations§
Source§impl ResponseBody
impl ResponseBody
Sourcepub fn raw(
body: impl Into<String>,
content_type: impl Into<String>,
) -> Result<Self, BaseError>
pub fn raw( body: impl Into<String>, content_type: impl Into<String>, ) -> Result<Self, BaseError>
构造原始响应体,传输层将原样返回 body 而不套 ApiResponse 包络。
这是给「外部系统契约与框架包络不兼容」用的逃生口,不是通用响应通道——
content_type 被限死为 application/json,防止它被用来返回 text/html。
该白名单与派发边界 wrap_dispatch_output 的运行期再校验完全一致;
直接构造 ResponseBody::Raw 的非法 content_type 会在派发时被拒绝。
§错误
content_type 不是 application/json 时返回 BaseError::ConfigError。
§示例
use yang_base::action::ResponseBody;
let body = ResponseBody::raw(r#"{"code":0}"#, "application/json")?;
assert!(matches!(body, ResponseBody::Raw { .. }));
// 非 JSON 类型被拒绝
assert!(ResponseBody::raw("<html></html>", "text/html").is_err());Trait Implementations§
Source§impl Clone for ResponseBody
impl Clone for ResponseBody
Source§impl Debug for ResponseBody
impl Debug for ResponseBody
impl Eq for ResponseBody
Source§impl From<ResponseBody> for ResponseAttachment
impl From<ResponseBody> for ResponseAttachment
Source§fn from(body: ResponseBody) -> Self
fn from(body: ResponseBody) -> Self
Source§impl JsonSchema for ResponseBody
impl JsonSchema for ResponseBody
Source§fn schema_name() -> String
fn schema_name() -> String
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref keyword. Read moreSource§impl PartialEq for ResponseBody
impl PartialEq for ResponseBody
Source§impl Serialize for ResponseBody
impl Serialize for ResponseBody
impl StructuralPartialEq for ResponseBody
Auto Trait Implementations§
impl Forget for ResponseBody
impl Freeze for ResponseBody
impl Move for ResponseBody
impl RefUnwindSafe for ResponseBody
impl Send for ResponseBody
impl Sync for ResponseBody
impl Unpin for ResponseBody
impl UnsafeUnpin for ResponseBody
impl UnwindSafe for ResponseBody
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more