Struct llamapun::dnm::DNMRange

pub struct DNMRange<'dnmrange> {
    pub start: usize,
    pub end: usize,
    pub dnm: &'dnmrange DNM,
}

Very often we’ll talk about substrings of the plaintext - words, sentences, etc. A DNMRange stores start and end point of such a substring and has a reference to the DNM.

Fields

start: usize

Offset of the beginning of the range

end: usize

Offset of the end of the range

dnm: &'dnmrange DNM

DNM containing this range

Implementations

impl<'dnmrange> DNMRange<'dnmrange>

pub fn get_plaintext(&self) -> &'dnmrange str

Get the plaintext substring corresponding to the range

pub fn get_plaintext_truncated(&self) -> &'dnmrange str

Get the plaintext without trailing white spaces

pub fn get_node(&self) -> RoNode

Get the first corresponding DOM node for this range

pub fn trim(&self) -> DNMRange<'dnmrange>

Returns a DNMRange with the leading and trailing whitespaces removed

pub fn get_subrange(
    &self,
    rel_start: usize,
    rel_end: usize
) -> DNMRange<'dnmrange>

returns a subrange, with offsets relative to the beginning of self

pub fn get_subrange_from_byte_offsets(
    &self,
    rel_start: usize,
    rel_end: usize
) -> DNMRange<'dnmrange>

returns a subrange from a pair of byte offsets (not character offsets, remember, we’re in UTF-8)

pub fn is_empty(&self) -> bool

checks whether the range is empty

pub fn serialize(&self) -> String

serializes a DNMRange into an XPointer

pub fn create_arange(from: &str, to: &str) -> String

creates an arange from to xpointers

pub fn serialize_offset(
    root_node: RoNode,
    node: RoNode,
    offset: i32,
    is_end: bool
) -> String

Serializes a node and an offset into an xpointer is_end indicates whether the node indicates the end of the interval

pub fn serialize_node(root_node: RoNode, node: RoNode, is_end: bool) -> String

serializes a node into an xpath expression

pub fn deserialize(
    string: &str,
    dnm: &'dnmrange DNM,
    xpath_context: &Context
) -> DNMRange<'dnmrange>

deserializes an xpointer into a DNMRange. Note that only a very limited subset of xpointers is supported. Essentially, you should not use it for deserialization of xpointers generated by any other tool. (TODO: Support a wider range of xpointers)

Trait Implementations

impl<'dnmrange> Clone for DNMRange<'dnmrange>

fn clone(&self) -> DNMRange<'dnmrange>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'dnmrange> Debug for DNMRange<'dnmrange>

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

Formats the value using the given formatter.