Struct Ns 

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

A namespace for Duat operations.

This is a unique identifier which makes sure you’re only affecting the parts of Duat that you want to affect. It is used in various places within duat:

• For adding Tags to Text.
• For adding and removing hooks.
• For dealing with the Gutter

Here’s an example of a namespace being used to add Tags to Text:

let mut text = txt!("This is text with no tags in it");
// This key will be used to modify text.
let ns1 = Ns::new();

let id = form::id_of!("invisible");

// You can create an `impl Tag` directly from a `FormId`
text.insert_tag(ns1, 18..20, id.to_tag(0));

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

// ns2 != ns1, so it shouldn't be able to change what was done with ns1.
let ns2 = Ns::new();
text.remove_tags(ns2, 18);

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

Implementations

impl Ns

pub fn new() -> Self

Returns a new, unique namespace.

pub const fn new_lazy() -> LazyLock<Self>

Returns a new LazyLock<Ns>.

You can use this in order to create static namespaces by calling something like:

use std::sync::LazyLock;

use duat::prelude::*;

static NS: LazyLock<Ns> = Ns::new_lazy();

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

Returns a number of new, unique namespaces

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 Buffer 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 is 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<'__de, __Context> BorrowDecode<'__de, __Context> for Ns

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Ns

fn clone(&self) -> Ns

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ns

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Ns

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for Ns

fn default() -> Self

Returns a new namespace.

Not to be confused with Ns::basic.

impl Encode for Ns

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Hash for Ns

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 Ns

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

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

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

impl Eq for Ns

impl StructuralPartialEq for Ns