mirror of
https://github.com/nushell/nushell.git
synced 2025-05-23 03:10:49 +02:00
# Description Our `ShellError` at the moment has a `std::mem::size_of<ShellError>` of 136 bytes (on AMD64). As a result `Value` directly storing the struct also required 136 bytes (thanks to alignment requirements). This change stores the `Value::Error` `ShellError` on the heap. Pro: - Value now needs just 80 bytes - Should be 1 cacheline less (still at least 2 cachelines) Con: - More small heap allocations when dealing with `Value::Error` - More heap fragmentation - Potential for additional required memcopies # Further code changes Includes a small refactor of `try` due to a type mismatch in its large match. # User-Facing Changes None for regular users. Plugin authors may have to update their matches on `Value` if they use `nu-protocol` Needs benchmarking to see if there is a benefit in real world workloads. **Update** small improvements in runtime for workloads with high volume of values. Significant reduction in maximum resident set size, when many values are held in memory. # Tests + Formatting
295 lines
9.2 KiB
Rust
295 lines
9.2 KiB
Rust
use ical::parser::ical::component::*;
|
|
use ical::property::Property;
|
|
use indexmap::map::IndexMap;
|
|
use nu_plugin::{EvaluatedCall, LabeledError};
|
|
use nu_protocol::{PluginExample, ShellError, Span, Spanned, Value};
|
|
use std::io::BufReader;
|
|
|
|
pub const CMD_NAME: &str = "from ics";
|
|
|
|
pub fn from_ics_call(call: &EvaluatedCall, input: &Value) -> Result<Value, LabeledError> {
|
|
let span = input.span().unwrap_or(call.head);
|
|
let input_string = input.as_string()?;
|
|
let head = call.head;
|
|
|
|
let input_string = input_string
|
|
.lines()
|
|
.map(|x| x.trim().to_string())
|
|
.collect::<Vec<_>>()
|
|
.join("\n");
|
|
|
|
let input_bytes = input_string.as_bytes();
|
|
let buf_reader = BufReader::new(input_bytes);
|
|
let parser = ical::IcalParser::new(buf_reader);
|
|
|
|
let mut output = vec![];
|
|
|
|
for calendar in parser {
|
|
match calendar {
|
|
Ok(c) => output.push(calendar_to_value(c, head)),
|
|
Err(e) => output.push(Value::Error {
|
|
error: Box::new(ShellError::UnsupportedInput(
|
|
format!("input cannot be parsed as .ics ({e})"),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
)),
|
|
}),
|
|
}
|
|
}
|
|
Ok(Value::List {
|
|
vals: output,
|
|
span: head,
|
|
})
|
|
}
|
|
|
|
pub fn examples() -> Vec<PluginExample> {
|
|
vec![PluginExample {
|
|
example: "'BEGIN:VCALENDAR
|
|
END:VCALENDAR' | from ics"
|
|
.into(),
|
|
description: "Converts ics formatted string to table".into(),
|
|
result: Some(Value::List {
|
|
vals: vec![Value::Record {
|
|
cols: vec![
|
|
"properties".to_string(),
|
|
"events".to_string(),
|
|
"alarms".to_string(),
|
|
"to-Dos".to_string(),
|
|
"journals".to_string(),
|
|
"free-busys".to_string(),
|
|
"timezones".to_string(),
|
|
],
|
|
vals: vec![
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
Value::List {
|
|
vals: vec![],
|
|
span: Span::test_data(),
|
|
},
|
|
],
|
|
span: Span::test_data(),
|
|
}],
|
|
span: Span::test_data(),
|
|
}),
|
|
}]
|
|
}
|
|
|
|
fn calendar_to_value(calendar: IcalCalendar, span: Span) -> Value {
|
|
let mut row = IndexMap::new();
|
|
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(calendar.properties, span),
|
|
);
|
|
row.insert("events".to_string(), events_to_value(calendar.events, span));
|
|
row.insert("alarms".to_string(), alarms_to_value(calendar.alarms, span));
|
|
row.insert("to-Dos".to_string(), todos_to_value(calendar.todos, span));
|
|
row.insert(
|
|
"journals".to_string(),
|
|
journals_to_value(calendar.journals, span),
|
|
);
|
|
row.insert(
|
|
"free-busys".to_string(),
|
|
free_busys_to_value(calendar.free_busys, span),
|
|
);
|
|
row.insert(
|
|
"timezones".to_string(),
|
|
timezones_to_value(calendar.timezones, span),
|
|
);
|
|
|
|
Value::from(Spanned { item: row, span })
|
|
}
|
|
|
|
fn events_to_value(events: Vec<IcalEvent>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: events
|
|
.into_iter()
|
|
.map(|event| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(event.properties, span),
|
|
);
|
|
row.insert("alarms".to_string(), alarms_to_value(event.alarms, span));
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn alarms_to_value(alarms: Vec<IcalAlarm>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: alarms
|
|
.into_iter()
|
|
.map(|alarm| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(alarm.properties, span),
|
|
);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn todos_to_value(todos: Vec<IcalTodo>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: todos
|
|
.into_iter()
|
|
.map(|todo| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(todo.properties, span),
|
|
);
|
|
row.insert("alarms".to_string(), alarms_to_value(todo.alarms, span));
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn journals_to_value(journals: Vec<IcalJournal>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: journals
|
|
.into_iter()
|
|
.map(|journal| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(journal.properties, span),
|
|
);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn free_busys_to_value(free_busys: Vec<IcalFreeBusy>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: free_busys
|
|
.into_iter()
|
|
.map(|free_busy| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(free_busy.properties, span),
|
|
);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn timezones_to_value(timezones: Vec<IcalTimeZone>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: timezones
|
|
.into_iter()
|
|
.map(|timezone| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(timezone.properties, span),
|
|
);
|
|
row.insert(
|
|
"transitions".to_string(),
|
|
timezone_transitions_to_value(timezone.transitions, span),
|
|
);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn timezone_transitions_to_value(transitions: Vec<IcalTimeZoneTransition>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: transitions
|
|
.into_iter()
|
|
.map(|transition| {
|
|
let mut row = IndexMap::new();
|
|
row.insert(
|
|
"properties".to_string(),
|
|
properties_to_value(transition.properties, span),
|
|
);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn properties_to_value(properties: Vec<Property>, span: Span) -> Value {
|
|
Value::List {
|
|
vals: properties
|
|
.into_iter()
|
|
.map(|prop| {
|
|
let mut row = IndexMap::new();
|
|
|
|
let name = Value::String {
|
|
val: prop.name,
|
|
span,
|
|
};
|
|
let value = match prop.value {
|
|
Some(val) => Value::String { val, span },
|
|
None => Value::nothing(span),
|
|
};
|
|
let params = match prop.params {
|
|
Some(param_list) => params_to_value(param_list, span),
|
|
None => Value::nothing(span),
|
|
};
|
|
|
|
row.insert("name".to_string(), name);
|
|
row.insert("value".to_string(), value);
|
|
row.insert("params".to_string(), params);
|
|
Value::from(Spanned { item: row, span })
|
|
})
|
|
.collect::<Vec<Value>>(),
|
|
span,
|
|
}
|
|
}
|
|
|
|
fn params_to_value(params: Vec<(String, Vec<String>)>, span: Span) -> Value {
|
|
let mut row = IndexMap::new();
|
|
|
|
for (param_name, param_values) in params {
|
|
let values: Vec<Value> = param_values
|
|
.into_iter()
|
|
.map(|val| Value::string(val, span))
|
|
.collect();
|
|
let values = Value::List { vals: values, span };
|
|
row.insert(param_name, values);
|
|
}
|
|
|
|
Value::from(Spanned { item: row, span })
|
|
}
|