Enum SelectionReason 

pub enum SelectionReason {
    Scored,
    Pinned,
    Explicit,
    Unknown,
}

Why the host selected this plugin.

Variants

Scored

It won on evidence: the highest score in the winning family.

Also the default: a hand-built context (in a plugin’s own test) starts from “nothing was pinned and nobody named me”, which is this.

Pinned

The project config pins this plugin’s family to it.

Explicit

The user named it on the command line.

Unknown

A reason this build of the contract does not know.

A newer host may add one, and an older plugin must still run: the reason is information, not something to refuse a call over.

Implementations

impl SelectionReason

pub const fn from_abi(raw: u32) -> Self

Read the number the host sent.

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

The word this reason is called by, for a plugin’s own messages.

pub const fn to_abi(self) -> u32

The number this reason crosses the boundary as.

SelectionReason::Unknown has none of its own – it means “this build does not know that reason” and only ever comes from a host – so it answers with the neutral PMPX_REASON_SCORED.

Trait Implementations

impl Clone for SelectionReason

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SelectionReason

impl Debug for SelectionReason

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

Formats the value using the given formatter.

impl Default for SelectionReason

fn default() -> Self

Returns the “default value” for a type.

impl Display for SelectionReason

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

Formats the value using the given formatter.

impl Eq for SelectionReason

impl PartialEq for SelectionReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SelectionReason