Enum Bias 

pub enum Bias {
    Left,
    Right,
}

Bias is used to settle ambiguities when determining positions in an ordered sequence.

The primary use case is for text, where Bias influences which character an offset or anchor is associated with.

Examples

Given the buffer AˇBCD:

• The offset of the cursor is 1
• Bias::Left would attach the cursor to the character A
• Bias::Right would attach the cursor to the character B

Given the buffer A«BCˇ»D:

• The offset of the cursor is 3, and the selection is from 1 to 3
• The left anchor of the selection has Bias::Right, attaching it to the character B
• The right anchor of the selection has Bias::Left, attaching it to the character C

Given the buffer {ˇ<...>, where <...> is a folded region:

• The display offset of the cursor is 1, but the offset in the buffer is determined by the bias
• Bias::Left would attach the cursor to the character {, with a buffer offset of 1
• Bias::Right would attach the cursor to the first character of the folded region, and the buffer offset would be the offset of the first character of the folded region

Variants

Left

Attach to the character on the left

Right

Attach to the character on the right

Implementations

impl Bias

pub fn invert(self) -> Self

Trait Implementations

impl Clone for Bias

fn clone(&self) -> Bias

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bias

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

Formats the value using the given formatter.

impl Default for Bias

fn default() -> Bias

Returns the “default value” for a type.

impl Hash for Bias

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Bias

fn cmp(&self, other: &Bias) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bias

fn eq(&self, other: &Bias) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Bias

fn partial_cmp(&self, other: &Bias) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Bias

impl Eq for Bias

impl StructuralPartialEq for Bias