Enum DescriptionValue 

pub enum DescriptionValue {
    Text(SharedString),
    Unknown,
    NotApplicable,
    Redacted(SharedString),
}

What a detail row holds.

Variants

Text(SharedString)

Unknown

Nobody knows what this is. Not the same as empty.

NotApplicable

The question does not arise for this record.

Redacted(SharedString)

The value exists and may not be shown. Only its shape is carried, so there is no text here for a snapshot or an export to leak.

Implementations

impl DescriptionValue

pub fn text(value: impl Into<SharedString>) -> Self

pub fn redacted(shape: impl Into<SharedString>) -> Self

A redacted value described by its shape, such as "51 characters".

The shape is all the component ever sees. Callers that hold the secret itself want DescriptionValue::redacted_from, which measures the text and drops it.

pub fn redacted_from(secret: &str, cx: &App) -> Self

Measures a secret and keeps only the measurement.

The measurement is a sentence a reader reads, so it comes from the installed catalogue rather than from this file.

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

The name a semantic node publishes for the kind of value this is.

Trait Implementations

impl Clone for DescriptionValue

fn clone(&self) -> DescriptionValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptionValue

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

Formats the value using the given formatter.

impl Eq for DescriptionValue

impl From<&'static str> for DescriptionValue

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<SharedString> for DescriptionValue

fn from(value: SharedString) -> Self

Converts to this type from the input type.

impl From<String> for DescriptionValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for DescriptionValue

fn eq(&self, other: &DescriptionValue) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DescriptionValue