Struct SequentialText 

pub struct SequentialText {
    pub header: Vec<u8>,
    pub text: Vec<u8>,
}

Structured representation of text files on disk. There is a page structure that we do not put into the structure. As a result the decoder must pass over nulls, the encoder must insert them.

Fields

header: Vec<u8>

text: Vec<u8>

Trait Implementations

impl DiskStruct for SequentialText

fn new() -> Self

Create an empty structure

fn from_bytes(dat: &[u8]) -> Result<Self, DiskStructError>

Create structure using flattened bytes (typically from disk) Due to the pagination, we must keep all the nulls.

fn to_bytes(&self) -> Vec<u8>

Return flattened bytes (typically written to disk)

fn update_from_bytes(&mut self, dat: &[u8]) -> Result<(), DiskStructError>

Update with flattened bytes (useful mostly as a crutch within a2kit_macro)

fn len(&self) -> usize

Length of the flattened structure

fn from_bytes_adv( bytes: &[u8], ptr: &mut usize, ) -> Result<Self, DiskStructError>

where Self: Sized,

convenience function to call from_bytes and increment ptr by len()

impl Display for SequentialText

Allows the text to be displayed to the console using println!. This also derives to_string, so the structure can be converted to String.

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

Formats the value using the given formatter.

impl FromStr for SequentialText

Allows the structure to be created from string slices using from_str.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.