Struct Rule

pub struct Rule { /* private fields */ }

A Transformer paired with Applicability and a priority which can be applied to fields in a CSV record.

Implementations

impl Rule

pub fn for_fields(field_names: &[&str], transformer: Transformers) -> Rule

Construct a new Rule whoe Transformer is applicable to one or more CSV record’s fields referenced by name with the default priority of 0.

Examples

use csv_sanity::Rule;
use csv_sanity::transformers::*;

let rule = Rule::for_fields(&["First Name", "Last Name"], Transformers::Capitalize(
    CapitalizeTransformer::new()
));

pub fn for_fields_with_priority( field_names: &[&str], transformer: Transformers, priority: isize, ) -> Rule

Construct a new Rule whoe Transformer is applicable to one or more CSV record’s fields referenced by name with the specified priority.

Examples

use csv_sanity::Rule;
use csv_sanity::transformers::*;

let rule = Rule::for_fields_with_priority(&["Fist Name", "Last Name"], Transformers::Capitalize(
    CapitalizeTransformer::new()
), 10);

pub fn global(transformer: Transformers) -> Rule

Construct a new Rule applicable to all of a CSV record’s fields with the default priority of 0.

Examples

use csv_sanity::Rule;
use csv_sanity::transformers::*;

let rule = Rule::global(Transformers::Capitalize(
    CapitalizeTransformer::new()
));

pub fn global_with_priority(transformer: Transformers, priority: isize) -> Rule

Construct a new Rule applicable to all of a CSV record’s fields with the specified priority.

Examples

use csv_sanity::Rule;
use csv_sanity::transformers::*;

let rule = Rule::global_with_priority(Transformers::Capitalize(
    CapitalizeTransformer::new()
), 10);

pub fn apply( &self, field_value: &str, field_name: &str, record_n: usize, ) -> TransformResult

Apply this rule to a CSV record’s field, returning the resulting TransformResult.

Examples

use csv_sanity::Rule;
use csv_sanity::transformers::*;

let field = "JOHN";
let field_name = "First Name";

let rule = Rule::for_fields(&["First Name", "Last Name"], Transformers::Capitalize(
    CapitalizeTransformer::new()
));
rule.apply(field, field_name, 1);

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Rule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rule

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Rule

fn eq(&self, other: &Rule) -> 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 PartialOrd for Rule

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Rule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Rule

impl StructuralPartialEq for Rule