proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-08-08 05:35:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

api-macro: allow optional types without Option<T>

Browse Source 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2020-03-19 12:08:10 +01:00
parent 832dd021c2
commit 83b6d082db
2 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
proxmox-api-macro/src/api/method.rs
View File

@ -164,8 +164,14 @@ fn handle_function_signature(
{ {
// try to infer the type in the schema if it is not specified explicitly: // try to infer the type in the schema if it is not specified explicitly:
let is_option = util::infer_type(schema, &*pat_type.ty)?; let is_option = util::infer_type(schema, &*pat_type.ty)?;
let has_default = schema.find_schema_property("default").is_some();
if !is_option && *optional { if !is_option && *optional {
bail!(pat_type => "non-optional `Option` type"); if !has_default {
bail!(pat_type => "optional types need a default or be an Option<T>");
}
}
if has_default && !*optional {
bail!(pat_type => "non-optional parameter cannot have a default");
} }
} else { } else {
continue; continue;
@ -332,7 +338,7 @@ fn create_wrapper_function(
ParameterType::Value => args.extend(quote_spanned! { span => input_params, }), ParameterType::Value => args.extend(quote_spanned! { span => input_params, }),
ParameterType::ApiMethod => args.extend(quote_spanned! { span => api_method_param, }), ParameterType::ApiMethod => args.extend(quote_spanned! { span => api_method_param, }),
ParameterType::RpcEnv => args.extend(quote_spanned! { span => rpc_env_param, }), ParameterType::RpcEnv => args.extend(quote_spanned! { span => rpc_env_param, }),
ParameterType::Other(_ty, optional, _schema) => { ParameterType::Other(ty, optional, schema) => {
let name_str = syn::LitStr::new(name.as_str(), span); let name_str = syn::LitStr::new(name.as_str(), span);
let arg_name = let arg_name =
Ident::new(&format!("input_arg_{}", name.as_ident().to_string()), span); Ident::new(&format!("input_arg_{}", name.as_ident().to_string()), span);
@ -346,7 +352,8 @@ fn create_wrapper_function(
.transpose()? .transpose()?
}); });
if !optional { if !optional {
// Non-optional types need to be extracted out of the option though: // Non-optional types need to be extracted out of the option though (unless
// they have a default):
// //
// Whether the parameter is optional should have been verified by the schema // Whether the parameter is optional should have been verified by the schema
// verifier already, so here we just use failure::bail! instead of building a // verifier already, so here we just use failure::bail! instead of building a
@ -357,6 +364,15 @@ fn create_wrapper_function(
#name_str, #name_str,
))? ))?
}); });
} else if util::is_option_type(ty).is_none() {
// Optional parameter without an Option<T> type requires a default:
if let Some(def) = schema.find_schema_property("default") {
body.extend(quote_spanned! { span =>
.unwrap_or_else(|| #def)
});
} else {
bail!(ty => "Optional parameter without Option<T> requires a default");
}
} }
body.extend(quote_spanned! { span => ; }); body.extend(quote_spanned! { span => ; });
args.extend(quote_spanned! { span => #arg_name, }); args.extend(quote_spanned! { span => #arg_name, });

2
proxmox-api-macro/src/util.rs
View File

@ -500,7 +500,7 @@ pub fn infer_type(schema: &mut Schema, ty: &syn::Type) -> Result<bool, syn::Erro
} }
/// Note that we cannot handle renamed imports at all here... /// Note that we cannot handle renamed imports at all here...
fn is_option_type(ty: &syn::Type) -> Option<&syn::Type> { pub fn is_option_type(ty: &syn::Type) -> Option<&syn::Type> {
if let syn::Type::Path(p) = ty { if let syn::Type::Path(p) = ty {
if p.qself.is_some() { if p.qself.is_some() {
return None; return None;