Skip to main content

Inlay

Struct Inlay 

Source
pub struct Inlay { /* private fields */ }
Expand description

Builder part and Tag: Places ghost Text within real Text.

This is useful when, for example, creating command line prompts, since the text is non interactable.

Implementations§

Source§

impl Inlay

Source

pub fn new(value: impl Into<Text>) -> Self

Returns a new inlay type Inlay, which can be inserted on Text.

This ghost Text will be placed as if it were regular text, taking up space on screen, shifting the real text around to accomodate itself. One of the most prominent uses of it is in the prompt text of the PromptLine.

If you want ghost Text that goes over the real Text, check out Overlay.

Source

pub fn text(&self) -> &Text

The Text of this Inlay

Trait Implementations§

Source§

impl AsBuilderPart for Inlay

Source§

fn as_builder_part(&self) -> BuilderPart<'_>

Gets a BuilderPart fro this value
Source§

impl Clone for Inlay

Source§

fn clone(&self) -> Inlay

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Inlay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Tag<Point> for Inlay

Source§

const IS_META: bool = true

A meta Tag is one that changes the layout of the Text itself. Read more
Source§

impl Tag<usize> for Inlay

Source§

const IS_META: bool = true

A meta Tag is one that changes the layout of the Text itself. Read more

Auto Trait Implementations§

§

impl Freeze for Inlay

§

impl !RefUnwindSafe for Inlay

§

impl Send for Inlay

§

impl Sync for Inlay

§

impl Unpin for Inlay

§

impl UnsafeUnpin for Inlay

§

impl !UnwindSafe for Inlay

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryClone for T
where T: Clone,

Source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.