Struct fixed_width::Field

pub struct Field {
    pub name: Option<String>,
    pub range: Range<usize>,
    pub pad_with: char,
    pub justify: Justify,
}

Defines a field in a fixed width record. There can be 1 or more fields in a fixed width record.

Fields

name: Option<String>

Name of the field.

range: Range<usize>

Byte range of the field.

pad_with: char

The character to use for padding the field.

justify: Justify

The justification (Left or Right) of the field.

Methods

impl Field

pub fn width(&self) -> usize

Sets the width of this field in bytes, as specified by the range (start - end).

Example

use fixed_width::Field;

let field = Field::default().range(0..5);

assert_eq!(field.width(), 5);

pub fn name<T: Into<String>>(self, val: Option<T>) -> Self

Sets the name of this field. Mainly used when deserializing into a HashMap to derive the keys.

Example

use fixed_width::Field;

let field = Field::default().name(Some("thing"));

assert_eq!(field.name, Some("thing".to_string()));

pub fn range(self, val: Range<usize>) -> Self

Sets the range in bytes of this field. The start value represents the first byte of the field, and the end represents the last byte + 1 because this is an exclusive Range.

Example

use fixed_width::Field;

let field = Field::default().range(0..4);

assert_eq!(field.range, 0..4);

pub fn pad_with(self, val: char) -> Self

Sets the character to use as padding the value of this field to its byte width.

Example

use fixed_width::Field;

let field = Field::default().pad_with('a');

assert_eq!(field.pad_with, 'a');

pub fn justify<T: Into<Justify>>(self, val: T) -> Self

Sets the justification to use for this field. Left will align to the left and Right to the right.

Example

use fixed_width::{Field, Justify};

let field = Field::default().justify(Justify::Right);

assert_eq!(field.justify, Justify::Right);

Trait Implementations

impl Default for Field

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Field

fn clone(&self) -> Field

Returns a copy 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.