Struct raystack::Grid

pub struct Grid { /* fields omitted */ }

A wrapper around a serde_json::Value which represents a Haystack Grid. Columns will always be sorted in alphabetical order.

Methods

impl Grid

pub fn new(rows: Vec<Value>) -> Result<Self, ParseJsonGridError>

Create a new Grid from rows. Each row must be a JSON Object.

Example

use raystack::Grid;
use serde_json::json;

let row = json!({"firstName": "Otis", "lastName": "Jackson Jr."});
let rows = vec![row];
let grid = Grid::new(rows).unwrap();
assert_eq!(grid.rows()[0]["firstName"], "Otis");

pub fn empty() -> Self

Create an empty grid.

pub fn meta(&self) -> &Map<String, Value>

Return a map which represents the metadata for the grid.

pub fn to_meta(&self) -> Map<String, Value>

Return an owned map, which represents the metadata for the grid.

pub fn cols(&self) -> &Vec<Value>

Return a vector of JSON values which represent the columns of the grid.

pub fn add_col<F>(&mut self, col_name: TagName, f: F) where
    F: Fn(&mut Map<String, Value>) -> Value, 

Add a new column, or overwrite an existing column by mapping each row to a new cell value.

pub fn to_cols(&self) -> Vec<Value>

Return a vector of owned JSON values which represent the columns of the grid.

pub fn col_names(&self) -> Vec<TagName>

Return a vector containing the column names in this grid.

pub fn col_name_strs(&self) -> Vec<&str>

Return a vector containing the column names in this grid, as strings.

pub fn col_to_vec(&self, col_name: &str) -> Vec<Option<&Value>>

Return a vector containing the values in the given column.

pub fn has_col_name(&self, name: &str) -> bool

Returns true if the grid contains the given column name.

pub fn remove_col(&mut self, col_name: &str) -> bool

Remove the column name from the grid if it is present, and return true if the column was removed.

pub fn remove_cols(&mut self, col_names: &[&str]) -> u32

Remove the column names from the grid and return the number of columns that were removed. If a column name is not in the grid, nothing happens for that column name, and it does not increase the count of removed columns.

pub fn keep_cols(&mut self, cols_to_keep: &[&str])

Keep the given column names and remove all other columns. If the column name is not present, nothing happens for that column name.

pub fn rename_col(&mut self, col_name: &TagName, new_col_name: &TagName) -> bool

Rename a column in the grid. If the original column was contained in the grid, return true. If the original column did not exist in the grid, this function does not modify the grid, and returns false.

pub fn rows(&self) -> &Vec<Value>

Return a vector of JSON values which represent the rows of the grid.

pub fn row_maps(&self) -> Vec<&Map<String, Value>>

Return a vector of Maps which represent the rows of the grid.

pub fn to_rows(&self) -> Vec<Value>

Return a vector of owned JSON values which represent the rows of the grid.

pub fn to_row_maps(&self) -> Vec<Map<String, Value>>

Return a vector of owned JSON values which represent the rows of the grid.

pub fn sort_rows<F>(&mut self, compare: F) where
    F: FnMut(&Value, &Value) -> Ordering, 

Sort the rows with a comparator function. This sort is stable.

pub fn add_row(&mut self, row: Value) -> Result<(), ParseJsonGridError>

Add a row to the grid. The row must be a JSON object.

pub fn add_rows(&mut self, rows: Vec<Value>) -> Result<(), ParseJsonGridError>

Add rows to the grid. The rows to add must be a Vec containing only JSON objects.

pub fn size(&self) -> usize

Return the number of rows in the grid.

pub fn is_empty(&self) -> bool

Return true if the grid has no rows.

pub fn concat_grid(&mut self, grid: Grid)

Concatenate the rows in the given grid to the current grid.

pub fn concat_grids(&mut self, grids: Vec<Grid>)

For each given grid, concatenate its rows to the current grid.

pub fn concat_all(grids: Vec<Grid>) -> Grid

Return a new grid which is formed by concatenating all the given grids together.

pub fn to_json_string(&self) -> String

Return the string representation of the underlying JSON value.

pub fn to_json_string_pretty(&self) -> String

Return a pretty formatted string representing the underlying JSON value.

pub fn is_error(&self) -> bool

Returns true if the grid appears to be an error grid.

pub fn error_trace(&self) -> Option<String>

Return the error trace if present.

pub fn to_csv_string_with_ordered_cols(
    &self,
    col_names: &[&str]
) -> Result<String, CsvError>

Return a string containing a CSV representation of the grid. The CSV string will have a header containing only the given column names, in the same order as they were provided. The header will include any given column names which are not present in the grid itself.

Nested structures such as Dicts (JSON objects) or Lists (JSON arrays) will not be expanded, and will be displayed as <StructureType>.

Example:

use raystack::Grid;
use serde_json::json;

let grid = Grid::new(vec![json!({"id": 1, "x": 2, "y": 3})]).unwrap();
let ordered_cols = vec!["y", "x", "colWithNoValues"];
let csv_string = grid
    .to_csv_string_with_ordered_cols(&ordered_cols)
    .unwrap();

assert_eq!(
    csv_string,
    "y,x,colWithNoValues\n3,2,\n".to_string()
);

pub fn to_csv_string(&self) -> Result<String, CsvError>

Return a string containing a CSV representation of the grid.

Nested structures such as Dicts (JSON objects) or Lists (JSON arrays) will not be expanded, and will be displayed as <StructureType>.

Example:

use raystack::Grid;
use serde_json::json;

let grid = Grid::new(vec![json!({"id": 1, "x": 2, "y": 3})]).unwrap();
let csv_string = grid
    .to_csv_string()
    .unwrap();

assert_eq!(
    csv_string,
    "id,x,y\n1,2,3\n".to_string()
);

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<Grid> for Grid

fn eq(&self, other: &Grid) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Grid) -> bool

This method tests for !=.

impl Debug for Grid

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl TryFrom<Value> for Grid

type Error = ParseJsonGridError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Grid