Struct pica_record::StringRecord

pub struct StringRecord<'a>(/* private fields */);

A record, that guarantees valid UTF-8 data.

Methods from Deref<Target = ByteRecord<'a>>

pub fn write_to(&self, out: &mut impl Write) -> Result<()>

Write the ByteRecord into the given writer.

Example

use std::io::Cursor;

use pica_record::ByteRecord;

let mut writer = Cursor::new(Vec::<u8>::new());
let record = ByteRecord::from_bytes(b"003@ \x1f0a\x1e\n")?;
record.write_to(&mut writer);

assert_eq!(
    String::from_utf8(writer.into_inner())?,
    "003@ \x1f0a\x1e\n"
);

pub fn retain<F: FnMut(&FieldRef<'_>) -> bool>(&mut self, f: F)

Retains only the fields specified by the predicate.

Example

use pica_record::ByteRecord;

let mut record =
    ByteRecord::from_bytes(b"003@ \x1f0a\x1e002@ \x1f0Olfo\x1e\n")?;
record.retain(|field| field.tag() == "003@");
assert_eq!(record.fields().len(), 1);

pub fn sha256(&self) -> Vec<u8>

Returns the SHA-256 hash of the record.

Example

use std::fmt::Write;

use pica_record::ByteRecord;

let mut record = ByteRecord::from_bytes(b"012A \x1fa123\x1e\n")?;

let hash =
    record.sha256().iter().fold(String::new(), |mut out, b| {
        let _ = write!(out, "{b:02x}");
        out
    });

assert!(hash.starts_with("95e266"));

Methods from Deref<Target = RecordRef<'a>>

pub fn fields(&self) -> &[FieldRef<'a>]

Returns the fields of the record.

Example

use pica_record::primitives::{FieldRef, RecordRef};

let record = RecordRef::from_bytes(b"012A \x1f0abc\x1e\n")?;
let field = FieldRef::from_bytes(b"012A \x1f0abc\x1e")?;
assert_eq!(record.fields(), [field]);

pub fn is_empty(&self) -> bool

Returns true if the RecordRef contains no fields, otherwise false.

Example

use pica_record::primitives::RecordRef;

let record = RecordRef::from_bytes(b"002@ \x1f0Oaf\x1e\n")?;
assert!(!record.is_empty());

pub fn retain<F: FnMut(&FieldRef<'_>) -> bool>(&mut self, f: F)

Retains only the FieldRefs specified by the predicate.

Example

use pica_record::primitives::RecordRef;

let mut record = RecordRef::new(vec![
    ("003@", None, vec![('0', "123456789X")]),
    ("002@", None, vec![('0', "Oaf")]),
])?;

assert_eq!(record.fields().len(), 2);

record.retain(|field| field.tag() == "003@");
assert_eq!(record.fields().len(), 1);

pub fn validate(&self) -> Result<(), Utf8Error>

Returns an std::str::Utf8Error if the record contains invalid UTF-8 data, otherwise the unit.

Example

use pica_record::primitives::RecordRef;

let record = RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?;
assert!(record.validate().is_ok());

pub fn write_to(&self, out: &mut impl Write) -> Result<()>

Write the RecordRef into the given writer.

Example

use std::io::Cursor;

use pica_record::primitives::RecordRef;

let mut writer = Cursor::new(Vec::<u8>::new());
let record = RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?;
record.write_to(&mut writer);

assert_eq!(
    String::from_utf8(writer.into_inner())?,
    "003@ \x1f0a\x1e\n"
);

Trait Implementations

impl<'a> Debug for StringRecord<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for StringRecord<'a>

type Target = ByteRecord<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for StringRecord<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> TryFrom<ByteRecord<'a>> for StringRecord<'a>

fn try_from(record: ByteRecord<'a>) -> Result<Self, Self::Error>

Creates a StringRecord from a ByteRecord.

Errors

If the underlying ByteRecord contains invalid UTF-8 sequences, an Utf8Error is returned.

Example

use pica_record::{ByteRecord, StringRecord};

let record = ByteRecord::from_bytes(b"012A \x1fa123\x1e\n")?;
let record = StringRecord::try_from(record)?;
assert_eq!(record.fields().len(), 1);

type Error = Utf8Error

The type returned in the event of a conversion error.