Trait an_rope::metric::Measured

pub trait Measured<M: Metric> {
    fn measure(&self) -> M;
    fn measure_weight(&self) -> M;
    fn to_byte_index(&self, index: M) -> Option<usize>;
}

Trait indicating that a type may be measured with Metric M.

Required Methods

fn measure(&self) -> M

Apply Metric to Self

Although we aren't currently enforcing this, measureing a Node with two children should produce the same result as measureing both children and Monoid::summing the result. That is to say, measure should be a monoid homomorphism.

fn measure_weight(&self) -> M

Measure the weight of Node by this metric.

fn to_byte_index(&self, index: M) -> Option<usize>

Convert the Metric into a byte index into the given Node

Returns

• Some with the byte index of the beginning of the nth element in node measured by this Metric, if there is an nth element
• None if there is no nth element in node

Implementations on Foreign Types

impl Measured<Grapheme> for str

fn to_byte_index(&self, index: Grapheme) -> Option<usize>

Convert the Metric into a byte index into the given Node

Returns

• Some with the byte index of the beginning of the nth element in node measured by this Metric, if there is an nth element
• None if there is no nth element in node

fn measure(&self) -> Grapheme

fn measure_weight(&self) -> Grapheme

impl Measured<Grapheme> for String

fn to_byte_index(&self, index: Grapheme) -> Option<usize>

fn measure(&self) -> Grapheme

fn measure_weight(&self) -> Grapheme

impl Measured<Line> for str

fn to_byte_index(&self, index: Line) -> Option<usize>

fn measure(&self) -> Line

fn measure_weight(&self) -> Line

impl Measured<Line> for String

fn to_byte_index(&self, index: Line) -> Option<usize>

fn measure(&self) -> Line

fn measure_weight(&self) -> Line

impl Measured<usize> for str

fn to_byte_index(&self, index: usize) -> Option<usize>

fn measure(&self) -> usize

fn measure_weight(&self) -> usize

impl Measured<usize> for String

fn to_byte_index(&self, index: usize) -> Option<usize>

fn measure(&self) -> usize

fn measure_weight(&self) -> usize

Implementors

• impl<M> Measured<M> for Rope where
    M: Metric,
    NodeLink: Measured<M>,
    String: Measured<M>,