Enum ContextRequirement 

pub enum ContextRequirement {
    Caret,
    Selection,
    FindHits,
}

A precondition on the invoking participant’s view. Declared on the published schema as an availability flag; checked against the invoker’s own view at invoke time.

Variants

Caret

The participant has a caret in an editable region.

Selection

The participant has a non-empty selection.

FindHits

The participant has live Find results.

Implementations

impl ContextRequirement

pub const ALL: [ContextRequirement; 3]

pub const fn tag(self) -> &'static str

The contract tag declaring this requirement.

pub const fn refusal_code(self) -> &'static str

Stable refusal code, e.g. needs-selection.

pub fn refusal(self) -> DoorError

The refusal for an invocation whose invoker’s view does not meet this requirement.

Trait Implementations

impl Clone for ContextRequirement

fn clone(&self) -> ContextRequirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextRequirement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContextRequirement

fn deserialize<__D>( __deserializer: __D, ) -> Result<ContextRequirement, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ContextRequirement

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 ContextRequirement

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

impl PartialEq for ContextRequirement

fn eq(&self, other: &ContextRequirement) -> 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 PartialOrd for ContextRequirement

fn partial_cmp(&self, other: &ContextRequirement) -> 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 ContextRequirement

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ContextRequirement

impl Eq for ContextRequirement

impl StructuralPartialEq for ContextRequirement