Struct FixedField

pub struct FixedField { /* private fields */ }

Fixed field with spec and value.

Since fixed fields have specific length requirements, a well-known spec::FixedField is required

Implementations

impl FixedField

pub fn new(spec: &'static FixedField, value: &str) -> Result<Self, Error>

Create a new FixeField using the provided spec and value. let mut ff = FixedField::new(&spec::FF_MAX_PRINT_WIDTH, “999”).unwrap();

Examples

use sip2::FixedField;
use sip2::spec;
assert!(FixedField::new(&spec::FF_MAX_PRINT_WIDTH, "999").is_ok());
assert!(FixedField::new(&spec::FF_MAX_PRINT_WIDTH, "999999").is_err());

pub fn spec(&self) -> &'static FixedField

Ref to the FixedField spec that defines our structure.

pub fn value(&self) -> &str

Value stored by this fixed field.

The length of the value will match the length defined by the Fixedfield spec.

pub fn set_value(&mut self, value: &str) -> Result<(), Error>

Apply a value to this FixedField.

Examples

use sip2::FixedField;
use sip2::spec;
let mut ff = FixedField::new(&spec::FF_MAX_PRINT_WIDTH, "999").unwrap();
ff.set_value("000").unwrap();
assert_eq!(ff.value(), "000");

assert!(ff.set_value("too long").is_err());

pub fn to_sip(&self) -> String

Translate a FixedField into a string which can be inserted into a SIP message.

use sip2::FixedField;
use sip2::spec;
let ff = FixedField::new(&spec::FF_MAX_PRINT_WIDTH, "999").unwrap();
assert_eq!(ff.to_sip(), "999");

Trait Implementations

impl Debug for FixedField

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

Formats the value using the given formatter.

impl PartialEq for FixedField

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