mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 23:28:13 +02:00
Name the Value conversion functions more clearly (#11851)
# Description This PR renames the conversion functions on `Value` to be more consistent. It follows the Rust [API guidelines](https://rust-lang.github.io/api-guidelines/naming.html#ad-hoc-conversions-follow-as_-to_-into_-conventions-c-conv) for ad-hoc conversions. The conversion functions on `Value` now come in a few forms: - `coerce_{type}` takes a `&Value` and attempts to convert the value to `type` (e.g., `i64` are converted to `f64`). This is the old behavior of some of the `as_{type}` functions -- these functions have simply been renamed to better reflect what they do. - The new `as_{type}` functions take a `&Value` and returns an `Ok` result only if the value is of `type` (no conversion is attempted). The returned value will be borrowed if `type` is non-`Copy`, otherwise an owned value is returned. - `into_{type}` exists for non-`Copy` types, but otherwise does not attempt conversion just like `as_type`. It takes an owned `Value` and always returns an owned result. - `coerce_into_{type}` has the same relationship with `coerce_{type}` as `into_{type}` does with `as_{type}`. - `to_{kind}_string`: conversion to different string formats (debug, abbreviated, etc.). Only two of the old string conversion functions were removed, the rest have been renamed only. - `to_{type}`: other conversion functions. Currently, only `to_path` exists. (And `to_string` through `Display`.) This table summaries the above: | Form | Cost | Input Ownership | Output Ownership | Converts `Value` case/`type` | | ---------------------------- | ----- | --------------- | ---------------- | -------- | | `as_{type}` | Cheap | Borrowed | Borrowed/Owned | No | | `into_{type}` | Cheap | Owned | Owned | No | | `coerce_{type}` | Cheap | Borrowed | Borrowed/Owned | Yes | | `coerce_into_{type}` | Cheap | Owned | Owned | Yes | | `to_{kind}_string` | Expensive | Borrowed | Owned | Yes | | `to_{type}` | Expensive | Borrowed | Owned | Yes | # User-Facing Changes Breaking API change for `Value` in `nu-protocol` which is exposed as part of the plugin API.
This commit is contained in:
Ian Manske
GitHub
@ -73,7 +73,7 @@ pub fn http_parse_url(
|
||||
span: Span,
|
||||
raw_url: Value,
|
||||
) -> Result<(String, Url), ShellError> {
|
||||
let requested_url = raw_url.as_string()?;
|
||||
let requested_url = raw_url.coerce_into_string()?;
|
||||
let url = match url::Url::parse(&requested_url) {
|
||||
Ok(u) => u,
|
||||
Err(_e) => {
|
||||
@ -222,8 +222,7 @@ pub fn send_request(
|
||||
let mut data: Vec<(String, String)> = Vec::with_capacity(val.len());
|
||||
|
||||
for (col, val) in val {
|
||||
let val_string = val.as_string()?;
|
||||
data.push((col, val_string))
|
||||
data.push((col, val.coerce_into_string()?))
|
||||
}
|
||||
|
||||
let request_fn = move || {
|
||||
@ -245,7 +244,7 @@ pub fn send_request(
|
||||
|
||||
let data = vals
|
||||
.chunks(2)
|
||||
.map(|it| Ok((it[0].as_string()?, it[1].as_string()?)))
|
||||
.map(|it| Ok((it[0].coerce_string()?, it[1].coerce_string()?)))
|
||||
.collect::<Result<Vec<(String, String)>, ShellErrorOrRequestError>>()?;
|
||||
|
||||
let request_fn = move || {
|
||||
@ -364,7 +363,7 @@ pub fn request_add_custom_headers(
|
||||
// primitive values ([key1 val1 key2 val2])
|
||||
for row in table.chunks(2) {
|
||||
if row.len() == 2 {
|
||||
custom_headers.insert(row[0].as_string()?, row[1].clone());
|
||||
custom_headers.insert(row[0].coerce_string()?, row[1].clone());
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -380,9 +379,9 @@ pub fn request_add_custom_headers(
|
||||
}
|
||||
};
|
||||
|
||||
for (k, v) in &custom_headers {
|
||||
if let Ok(s) = v.as_string() {
|
||||
request = request.set(k, &s);
|
||||
for (k, v) in custom_headers {
|
||||
if let Ok(s) = v.coerce_into_string() {
|
||||
request = request.set(&k, &s);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -684,17 +683,11 @@ pub fn request_handle_response_headers(
|
||||
}
|
||||
|
||||
fn retrieve_http_proxy_from_env(engine_state: &EngineState, stack: &mut Stack) -> Option<String> {
|
||||
let proxy_value: Option<Value> = stack
|
||||
stack
|
||||
.get_env_var(engine_state, "http_proxy")
|
||||
.or(stack.get_env_var(engine_state, "HTTP_PROXY"))
|
||||
.or(stack.get_env_var(engine_state, "https_proxy"))
|
||||
.or(stack.get_env_var(engine_state, "HTTPS_PROXY"))
|
||||
.or(stack.get_env_var(engine_state, "ALL_PROXY"));
|
||||
match proxy_value {
|
||||
Some(value) => match value.as_string() {
|
||||
Ok(proxy) => Some(proxy),
|
||||
_ => None,
|
||||
},
|
||||
_ => None,
|
||||
}
|
||||
.or(stack.get_env_var(engine_state, "ALL_PROXY"))
|
||||
.and_then(|proxy| proxy.coerce_into_string().ok())
|
||||
}
|
||||
|
||||
@ -70,7 +70,7 @@ fn to_url(input: PipelineData, head: Span) -> Result<PipelineData, ShellError> {
|
||||
Value::Record { ref val, .. } => {
|
||||
let mut row_vec = vec![];
|
||||
for (k, v) in val {
|
||||
match v.as_string() {
|
||||
match v.coerce_string() {
|
||||
Ok(s) => {
|
||||
row_vec.push((k.clone(), s.to_string()));
|
||||
}
|
||||
|
||||
@ -181,10 +181,10 @@ impl UrlComponents {
|
||||
|
||||
if key == "params" {
|
||||
return match value {
|
||||
Value::Record { ref val, .. } => {
|
||||
Value::Record { val, .. } => {
|
||||
let mut qs = val
|
||||
.iter()
|
||||
.map(|(k, v)| match v.as_string() {
|
||||
.into_iter()
|
||||
.map(|(k, v)| match v.coerce_into_string() {
|
||||
Ok(val) => Ok(format!("{k}={val}")),
|
||||
Err(err) => Err(err),
|
||||
})
|
||||
@ -202,7 +202,7 @@ impl UrlComponents {
|
||||
// if query is present it means that also query_span is set.
|
||||
return Err(ShellError::IncompatibleParameters {
|
||||
left_message: format!("Mismatch, qs from params is: {qs}"),
|
||||
left_span: value.span(),
|
||||
left_span: value_span,
|
||||
right_message: format!("instead query is: {q}"),
|
||||
right_span: self.query_span.unwrap_or(Span::unknown()),
|
||||
});
|
||||
@ -224,7 +224,7 @@ impl UrlComponents {
|
||||
}
|
||||
|
||||
// apart from port and params all other keys are strings.
|
||||
let s = value.as_string()?; // If value fails String conversion, just output this ShellError
|
||||
let s = value.coerce_into_string()?; // If value fails String conversion, just output this ShellError
|
||||
if !Self::check_empty_string_ok(&key, &s, value_span)? {
|
||||
return Ok(self);
|
||||
}
|
||||
@ -259,7 +259,7 @@ impl UrlComponents {
|
||||
// if query is present it means that also params_span is set.
|
||||
return Err(ShellError::IncompatibleParameters {
|
||||
left_message: format!("Mismatch, query param is: {s}"),
|
||||
left_span: value.span(),
|
||||
left_span: value_span,
|
||||
right_message: format!("instead qs from params is: {q}"),
|
||||
right_span: self.params_span.unwrap_or(Span::unknown()),
|
||||
});
|
||||
@ -268,7 +268,7 @@ impl UrlComponents {
|
||||
|
||||
Ok(Self {
|
||||
query: Some(format!("?{s}")),
|
||||
query_span: Some(value.span()),
|
||||
query_span: Some(value_span),
|
||||
..self
|
||||
})
|
||||
}
|
||||
|
||||
@ -75,7 +75,7 @@ impl Command for SubCommand {
|
||||
}
|
||||
|
||||
fn get_url_string(value: &Value, engine_state: &EngineState) -> String {
|
||||
value.into_string("", engine_state.get_config())
|
||||
value.to_expanded_string("", engine_state.get_config())
|
||||
}
|
||||
|
||||
fn parse(value: Value, head: Span, engine_state: &EngineState) -> Result<PipelineData, ShellError> {
|
||||
|
||||
Reference in New Issue
Block a user