Struct Headers

pub struct Headers { /* private fields */ }

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) -> bool

Adds a new header.

Returns wether the header was added or not.

use csvsc::{Headers, Row};

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

h.add("value");

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

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

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

fn clone(&self) -> Headers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

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

Formats the value using the given formatter.

impl Default for Headers

fn default() -> Self

Returns the “default value” for a type.

impl From<Headers> for Row

fn from(headers: Headers) -> Row

Converts to this type from the input type.

impl From<StringRecord> for Headers

fn from(row: Row) -> Headers

Converts to this type from the input type.

impl PartialEq<Headers> for Row

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Headers

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Headers