Struct xi_rope::breaks::BreaksInfo

pub struct BreaksInfo(_);

The number of breaks.

Trait Implementations

impl NodeInfo for BreaksInfo

type L = BreaksLeaf

The type of the leaf.

fn accumulate(&mut self, other: &Self)

An operator that combines info from two subtrees. It is intended (but not strictly enforced) that this operator be associative and obey an identity property. In mathematical terms, the accumulate method is the operation of a monoid.

fn compute_info(l: &BreaksLeaf) -> BreaksInfo

A mapping from a leaf into the info type. It is intended (but not strictly enforced) that applying the accumulate method to the info derived from two leaves gives the same result as deriving the info from the concatenation of the two leaves. In mathematical terms, the compute_info method is a monoid homomorphism.

fn identity() -> Self

The identity of the monoid. Need not be implemented because it can be computed from the leaf default.

fn interval(&self, len: usize) -> Interval

The interval covered by the first len base units of this node. The default impl is sufficient for most types, but interval trees may need to override it.

impl DefaultMetric for BreaksInfo

type DefaultMetric = BreaksBaseMetric

impl Metric<BreaksInfo> for BreaksMetric

fn measure(info: &BreaksInfo, _: usize) -> usize

Return the size of the NodeInfo::L, as measured by this metric.

fn to_base_units(l: &BreaksLeaf, in_measured_units: usize) -> usize

Returns the smallest offset, in base units, for an offset in measured units.

fn from_base_units(l: &BreaksLeaf, in_base_units: usize) -> usize

Returns the smallest offset in measured units corresponding to an offset in base units.

fn is_boundary(l: &BreaksLeaf, offset: usize) -> bool

Return whether the offset in base units is a boundary of this metric. If a boundary is at end of a leaf then this method must return true. However, a boundary at the beginning of a leaf is optional (the previous leaf will be queried).

fn prev(l: &BreaksLeaf, offset: usize) -> Option<usize>

Returns the index of the boundary directly preceding offset, or None if no such boundary exists. Input and result are in base units.

fn next(l: &BreaksLeaf, offset: usize) -> Option<usize>

Returns the index of the first boundary for which index > offset, or None if no such boundary exists. Input and result are in base units.

fn can_fragment() -> bool

Returns true if the measured units in this metric can span multiple leaves. As an example, in a metric that measures lines in a rope, a line may start in one leaf and end in another; however in a metric measuring bytes, storage of a single byte cannot extend across leaves.

impl Metric<BreaksInfo> for BreaksBaseMetric

fn measure(_: &BreaksInfo, len: usize) -> usize

Return the size of the NodeInfo::L, as measured by this metric.

fn to_base_units(_: &BreaksLeaf, in_measured_units: usize) -> usize

Returns the smallest offset, in base units, for an offset in measured units.

fn from_base_units(_: &BreaksLeaf, in_base_units: usize) -> usize

Returns the smallest offset in measured units corresponding to an offset in base units.

fn is_boundary(l: &BreaksLeaf, offset: usize) -> bool

Return whether the offset in base units is a boundary of this metric. If a boundary is at end of a leaf then this method must return true. However, a boundary at the beginning of a leaf is optional (the previous leaf will be queried).

fn prev(l: &BreaksLeaf, offset: usize) -> Option<usize>

Returns the index of the boundary directly preceding offset, or None if no such boundary exists. Input and result are in base units.

fn next(l: &BreaksLeaf, offset: usize) -> Option<usize>

Returns the index of the first boundary for which index > offset, or None if no such boundary exists. Input and result are in base units.

fn can_fragment() -> bool

Returns true if the measured units in this metric can span multiple leaves. As an example, in a metric that measures lines in a rope, a line may start in one leaf and end in another; however in a metric measuring bytes, storage of a single byte cannot extend across leaves.

impl Clone for BreaksInfo

fn clone(&self) -> BreaksInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BreaksInfo

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

Formats the value using the given formatter.