Struct Masked

pub struct Masked<'a> { /* private fields */ }

A wrapper around a string that is masked when displayed.

The masked string is displayed as a series of the same character. This might be used to display a password field or similar secure data.

Examples

use ratatui::{
    buffer::Buffer,
    layout::Rect,
    text::Masked,
    widgets::{Paragraph, Widget},
};

let mut buffer = Buffer::empty(Rect::new(0, 0, 5, 1));
let password = Masked::new("12345", 'x');

Paragraph::new(password).render(buffer.area, &mut buffer);
assert_eq!(buffer, Buffer::with_lines(["xxxxx"]));

Implementations

impl<'a> Masked<'a>

pub fn new(s: impl Into<Cow<'a, str>>, mask_char: char) -> Self

pub const fn mask_char(&self) -> char

The character to use for masking.

pub fn value(&self) -> Cow<'a, str>

The underlying string, with all characters masked.

Trait Implementations

impl<'a> Clone for Masked<'a>

fn clone(&self) -> Masked<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Masked<'_>

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

Debug representation of a masked string is the underlying string

impl<'a> Default for Masked<'a>

fn default() -> Masked<'a>

Returns the “default value” for a type.

impl Display for Masked<'_>

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

Display representation of a masked string is the masked string

impl<'a> From<&'a Masked<'_>> for Text<'a>

fn from(masked: &'a Masked<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Masked<'a>> for Cow<'a, str>

fn from(masked: &'a Masked<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<Masked<'a>> for Cow<'a, str>

fn from(masked: Masked<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Masked<'a>> for Text<'a>

fn from(masked: Masked<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Masked<'a>

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<'a> PartialEq for Masked<'a>

fn eq(&self, other: &Masked<'a>) -> 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<'a> Eq for Masked<'a>

impl<'a> StructuralPartialEq for Masked<'a>