Struct s4lib::data::line::LinePart

pub struct LinePart {
    pub blockp: BlockP,
    pub blocki_beg: BlockIndex,
    pub blocki_end: BlockIndex,
    pub blocksz: BlockSz,
    /* private fields */
}

A LinePart is some or all of a Line within a Block. The purpose of a LinePart is to help track a slice into a Block.

A Line can span more than one Block. A LinePart tracks the line data residing in one Block. One LinePart to one Block.

One or more LineParts are required for a Line.

A LinePart is essentially a slice with some extra “bells & whistles”.

Fields

blockp: BlockP

The Block pointer.

blocki_beg: BlockIndex

Index into the blockp, index at beginning used as-is in slice notation (inclusive).

blocki_end: BlockIndex

Index into the blockp, index at one after ending '\n' (may refer to one past end of Block) used as-is in slice notation (exclusive).

blocksz: BlockSz

The file-designated BlockSz, not necessarily the len() of the Block at blockp.

Implementations

impl LinePart

pub fn new( blockp: BlockP, blocki_beg: BlockIndex, blocki_end: BlockIndex, fileoffset: FileOffset, blockoffset: BlockOffset, blocksz: BlockSz ) -> LinePart

Create a new LinePart.

Remember that blocki_end points to one byte past because it used directly in byte array slice notation (exclusive). i.e. (*blockp)[blocki_beg‥blocki_end]

pub fn len(&self) -> usize

Length of LinePart starting at index blocki_beg in bytes.

pub fn is_empty(&self) -> bool

Clippy recommends fn is_empty since there is a len().

pub fn fileoffset_begin(&self) -> FileOffset

FileOffset at beginning of the LinePart (inclusive).

pub fn fileoffset_end(&self) -> FileOffset

FileOffset at one byte past ending of the LinePart (exclusive).

pub fn blockoffset(&self) -> BlockOffset

BlockOffset of underlying Block to which blockp points.

pub fn as_slice(&self) -> &[u8]

Return this linepart as a slice.

pub fn count_bytes(&self) -> Count

Count of bytes of this LinePart.

XXX: count_bytes and len is overlapping and confusing.

pub fn contains(self: &LinePart, byte_: &u8) -> bool

Does the LinePart contain the byte_?

pub fn block_boxptr(&self) -> Box<&[u8]>

Return Box pointer to slice of bytes that make up this LinePart.

pub fn block_boxptr_a(&self, a: &LineIndex) -> Box<&[u8]>

Return Box pointer to slice of bytes in this LinePart from a (inclusive) to end.

pub fn block_boxptr_b(&self, b: &LineIndex) -> Box<&[u8]>

Return Box pointer to slice of bytes in this LinePart from beginning to b (exclusive).

pub fn block_boxptr_ab(&self, a: &LineIndex, b: &LineIndex) -> Box<&[u8]>

Return Box pointer to slice of bytes in this LinePart from a (inclusive) to b (exclusive).

Trait Implementations

impl Debug for LinePart

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

Formats the value using the given formatter.