Struct Key

pub struct Key(/* private fields */);

A key letting one add and remove Tags to a Text

With keys, you can use the methods Text::insert_tag, Text::remove_tags_on, and Text::remove_tags_of to add and remove tags to a text.

The reason why keys exist is mainly for the sake of File widgets. In files, it is very expected that there will be many different sources of modifiers, which can add and remove tags on their own accord. In order to not have these different actors interfere with eachother’s work, keys were implemented:

use duat_core::{forms, text::{text, Key, Tag}};
let mut text = text!("This is text with no tags in it");
// This key will be used to modify text.
let key1 = Key::new();

let id = forms::id_of!("Invisible");

text.insert_tag(18, Tag::PushForm(id), key1);
text.insert_tag(21, Tag::PopForm(id), key1);

assert_eq!(
    text,
    text!("This is text with " [Invisible] "no " [] "tags in it")
);

// key2 != key, so it shouldn't be able to change what key1 has done.
let key2 = Key::new();

text.remove_tags_on(17, key2);

assert_eq!(
    text,
    text!("This is text with " [Invisible] "no " [] "tags in it")
);

Implementations

impl Key

pub fn new() -> Self

Returns a new, unique Key

pub fn new_many(amount: usize) -> Range<Self>

Returns a number of new, unique Keys

You may want to do this if you expect to be placing and removing a lot of tags, and you want the finest possible control over what gets added and deleted from the Text.

pub const fn basic() -> Self

A simple key with no uniqueness guarantee

You should use this if you’re editing widgets that are not the File widget, since you’re probably the only one that is going to be modifying said widget anyway.

The advantage of this function is speed. Since it has a const function, it’s value is just substituted in with the code, so there is no need to store it in structs or statics.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Self

Returns the “default value” for a type.

impl Keys for Key

fn range(self) -> Range<Key>

All Keys that should be searched

fn contains(self, key: Key) -> bool

Wether this range contains a given Key

impl Ord for Key

fn cmp(&self, other: &Key) -> 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 Key

fn eq(&self, other: &Key) -> 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 Key

fn partial_cmp(&self, other: &Key) -> 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 Step for Key

fn steps_between(start: &Self, end: &Self) -> Option<usize>

🔬This is a nightly-only experimental API. (step_trait)

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, count: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, count: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key