Struct csvsc::Headers

pub struct Headers { /* fields omitted */ }

A structure for keeping relationship between the headers and their positions

Implementations

impl Headers

pub fn new() -> Headers

Creates an empty Headers object.

pub fn get_field<'r>(&self, row: &'r Row, field: &str) -> Option<&'r str>

Retrieves a field from a row given it's header name

use csvsc::{Headers, Row};

let headers: Headers = Row::from(vec!["id", "val"]).into();
let row = Row::from(vec!["1", "40"]);

assert_eq!(headers.get_field(&row, "id"), Some("1"));
assert_eq!(headers.get_field(&row, "val"), Some("40"));
assert_eq!(headers.get_field(&row, "foo"), None);

pub fn add(&mut self, colname: &str) -> Result<(), ()>

Adds a new header. It'll fail if the header is already present

use csvsc::{Headers, Row};

let mut h: Headers = Row::from(vec!["name"]).into();

h.add("value").unwrap();

assert_eq!(h, Row::from(vec!["name", "value"]).into());

assert_eq!(h.add("name"), Err(()));
assert_eq!(h, Row::from(vec!["name", "value"]).into());

pub fn len(&self) -> usize

pub fn as_row(&self) -> &Row

pub fn into_row(self) -> Row

Consumes this Headers object and returns the underlaying Row containing the names.

pub fn index(&self, field: &str) -> Option<usize>

Obtains the index of the given field in the headers

pub fn contains_key(&self, field: &str) -> bool

pub fn iter(&self) -> StringRecordIter<'_>

Trait Implementations

impl Clone for Headers

pub fn clone(&self) -> Headers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Headers> for Row

pub fn from(headers: Headers) -> Row

Performs the conversion.

impl From<StringRecord> for Headers

pub fn from(row: Row) -> Headers

Performs the conversion.

impl PartialEq<Headers> for Headers

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

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

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

This method tests for !=.

impl PartialEq<Headers> for Row

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for Headers