Struct SurfaceFeature 

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

A capability a surface must have to present some part of an interaction: accepting secret input without echoing it, rendering a diagram, showing more than one control at once.

A named string rather than a closed enum, on purpose. This is a WIRE vocabulary: a v2 document may demand a feature this build has never heard of, and a closed enum could not even represent it — the name would be lost at parse time and law 5 would have nothing left to act on. Carrying the name verbatim is what lets an unknown demand be refused (when required) or reported (when optional) instead of silently vanishing.

Implementations

impl SurfaceFeature

pub const SECRET_INPUT: &'static str = "secret-input"

The surface accepts secret input without echoing or persisting it.

pub const DIAGRAMS: &'static str = "diagrams"

The surface renders a diagram extension (epic slice E0).

pub const MULTI_CONTROL: &'static str = "multi-control"

The surface can present more than one control at once.

pub const KNOWN: &'static [&'static str]

Every feature name this build understands.

pub fn new(name: impl Into<String>) -> Result<Self, ProtocolError>

Adopt a feature name.

Errors

ProtocolError::InvalidId when empty. An UNRECOGNIZED name is not an error — that is the forward-compatibility case, and is_known is how a consumer asks.

pub fn as_str(&self) -> &str

The name as written.

pub fn is_known(&self) -> bool

Whether this build understands the feature.

Trait Implementations

impl Clone for SurfaceFeature

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceFeature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfaceFeature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SurfaceFeature

impl From<SurfaceFeature> for String

fn from(value: SurfaceFeature) -> Self

Converts to this type from the input type.

impl Hash for SurfaceFeature

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 Ord for SurfaceFeature

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SurfaceFeature

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SurfaceFeature

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SurfaceFeature

impl TryFrom<String> for SurfaceFeature

type Error = ProtocolError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.