Trait lace::RowIndex

pub trait RowIndex: Clone + Debug {
    // Required methods
    fn row_ix(&self, codebook: &Codebook) -> Result<usize, IndexError>;
    fn row_str(&self) -> Option<&str>;
    fn row_usize(&self) -> Option<usize>;
}

Trait defining an item that can be converted into a row index

Required Methods

fn row_ix(&self, codebook: &Codebook) -> Result<usize, IndexError>

Use the codebook to return the integer row index

Example

use lace::examples::Example;
use lace::RowIndex;

let oracle = Example::Animals.oracle().unwrap();

// The first row
let ix = "antelope".row_ix(&oracle.codebook).unwrap();
assert_eq!(ix, 0);

// "flys" is a column name
let ix_res = "flys".row_ix(&oracle.codebook);
assert!(ix_res.is_err());

fn row_str(&self) -> Option<&str>

Return the item as a string reference, if possible

Example

use lace::RowIndex;

let ix = String::from("antelope");
assert!(ix.row_str().is_some());

let ix = 10_usize;
assert!(ix.row_str().is_none());

fn row_usize(&self) -> Option<usize>

Return the item as a usize, if possible

Example

use lace::RowIndex;

let ix = String::from("antelope");
assert!(ix.row_usize().is_none());

let ix = 10_usize;
assert_eq!(ix.row_usize(), Some(10));

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl RowIndex for usize

fn row_ix(&self, codebook: &Codebook) -> Result<usize, IndexError>

fn row_str(&self) -> Option<&str>

fn row_usize(&self) -> Option<usize>

impl RowIndex for String

fn row_ix(&self, codebook: &Codebook) -> Result<usize, IndexError>

fn row_str(&self) -> Option<&str>

fn row_usize(&self) -> Option<usize>

impl<'a> RowIndex for &'a str

fn row_ix(&self, codebook: &Codebook) -> Result<usize, IndexError>

fn row_str(&self) -> Option<&str>

fn row_usize(&self) -> Option<usize>

Implementors

impl RowIndex for &NameOrIndex

impl RowIndex for NameOrIndex