Struct SecretBool 

pub struct SecretBool { /* private fields */ }

A secure boolean type that redacts its content in all display contexts and zeros its memory on drop

Implementations

impl SecretBool

pub fn new(value: bool) -> Self

Create a new SecretBool from a regular boolean

pub fn new_with_template(value: bool, template: String) -> Self

Create a new SecretBool with a custom redaction template

pub fn reveal(&self) -> bool

Get a reference to the inner boolean (for controlled access)

pub fn into_inner(self) -> bool

Convert back to a regular boolean (consumes the SecretBool)

Trait Implementations

impl Clone for SecretBool

fn clone(&self) -> SecretBool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomValue for SecretBool

fn clone_value(&self, span: Span) -> Value

Custom Clone implementation

fn type_name(&self) -> String

The friendly type name to show for the custom value, e.g. in describe and in error messages. This does not have to be the same as the name of the struct or enum, but conventionally often is.

fn to_base_value(&self, span: Span) -> Result<Value, ShellError>

Converts the custom value to a base nushell value.

fn as_any(&self) -> &dyn Any

Any representation used to downcast object to its original type

fn as_mut_any(&mut self) -> &mut dyn Any

Any representation used to downcast object to its original type (mutable reference)

fn notify_plugin_on_drop(&self) -> bool

For custom values in plugins: return true here if you would like to be notified when all copies of this custom value are dropped in the engine.

fn follow_path_int( &self, self_span: Span, index: usize, path_span: Span, optional: bool, ) -> Result<Value, ShellError>

Follow cell path by numeric index (e.g. rows).

fn follow_path_string( &self, self_span: Span, column_name: String, path_span: Span, optional: bool, casing: Casing, ) -> Result<Value, ShellError>

Follow cell path by string key (e.g. columns).

fn partial_cmp(&self, _other: &Value) -> Option<Ordering>

ordering with other value (see std::cmp::PartialOrd)

fn operation( &self, lhs_span: Span, operator: Operator, op: Span, right: &Value, ) -> Result<Value, ShellError>

Definition of an operation between the object that implements the trait and another Value.

fn save( &self, path: Spanned<&Path>, value_span: Span, save_span: Span, ) -> Result<(), ShellError>

Save custom value to disk.

fn memory_size(&self) -> usize

Returns an estimate of the memory size used by this CustomValue in bytes

impl Debug for SecretBool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretBool

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretBool

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

Formats the value using the given formatter.

impl Drop for SecretBool

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for SecretBool

fn eq(&self, other: &Self) -> 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 Serialize for SecretBool

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ZeroizeOnDrop for SecretBool