Struct FormId 

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

An identifier of a Form

Builder part: Applies the Form destructively

This struct is always going to point to the same form, since those cannot be destroyed.

The main use for keeping these things directly is in order to modify a buffer’s text in an efficient manner, by adding tags directly, instead of using a macro like txt!

Implementations

impl FormId

pub const fn to_tag(self, prio: u8) -> FormTag

Creates a Tag out of this FormId

In order to push a Form to the Text, it needs a priority value, in order to properly sort the Forms within the same byte.

pub const fn to_u16(self) -> u16

The internal id of the FormId

This may be useful in certain situations.

pub fn name(self) -> &'static str

The name of this FormId

Trait Implementations

impl Clone for FormId

fn clone(&self) -> FormId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormId

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

Formats the value using the given formatter.

impl Default for FormId

fn default() -> FormId

Returns the “default value” for a type.

impl From<FormId> for BuilderPart

fn from(value: FormId) -> Self

Converts to this type from the input type.

impl Ord for FormId

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

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

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

impl Eq for FormId

impl StructuralPartialEq for FormId