Struct Field

pub struct Field { /* private fields */ }

Defines a field in a line record.

The Field definition is eventually used in comparison.

Examples

// specify that the second field of the record is a String and that its blanks to be stripped
// and case ignored for comparison
use text_file_sort::field::Field;
use text_file_sort::field_type::FieldType;
let field = Field::new(2, FieldType::String)
    .with_ignore_blanks(true)
    .with_ignore_case(true);

Implementations

impl Field

pub fn new(index: usize, field_type: FieldType) -> Field

Create a new Field

Arguments

• index - the index of the field, starting at 1. Index of 0 treats the complete line as a field
• field_type - the type of the field. See FieldType for supported types

Examples

use text_file_sort::field::Field;
use text_file_sort::field_type::FieldType;
let field = Field::new(1, FieldType::Integer);

pub fn name(&self) -> &String

Get the name for this field.

pub fn index(&self) -> usize

Get the index for this field.

pub fn field_type(&self) -> &FieldType

Get the FieldType for this field.

pub fn ignore_blanks(&self) -> bool

Get the ignore blanks setting for this field

pub fn ignore_case(&self) -> bool

Get the ignore case setting for this field.

pub fn random(&self) -> bool

Get the random setting for this field.

pub fn with_name(self, name: String) -> Field

Specify a name for this field

pub fn with_str_name(self, name: &str) -> Field

Specify a name for this field as &str

pub fn with_index(self, index: usize) -> Field

Specify the index for this field starting at 1. Specifying index of 0 treats the complete line as a field.

pub fn with_field_type(self, field_type: FieldType) -> Field

Specify the field type for this field. See FieldType for supported types.

pub fn with_ignore_blanks(self, ignore_blanks: bool) -> Field

Specify whether to ignore blanks for comparison. When true the field will be trimmed before comparison.

pub fn with_ignore_case(self, ignore_case: bool) -> Field

Specify whether to ignore case for comparison.

pub fn with_random(self, random: bool) -> Field

Specify whether to generate a random field value. Specifying true will cause the file to be randomly shuffled.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.