Enum InstructionKind

#[repr(i32)]
pub enum InstructionKind {
    Plugin = 0,
    GetMetadata = 1,
    Install = 2,
    Initialize = 3,
    Shutdown = 4,
    ChatMessage = 5,
    ChatCommand = 6,
    ScheduledJob = 7,
}

[Internal] Kinds of instructions that can be sent to hank plugins.

Variants

Plugin = 0

Plugin entry point.

GetMetadata = 1

Get the plugins metadata.

Install = 2

Call the plugins install function. (only happens once)

Initialize = 3

Call the plugins initialize function. (happens on every load)

Shutdown = 4

Call the plugins shutdown function. (happens on reload, unload, uninstall)

ChatMessage = 5

Call the plguins chat message handler.

ChatCommand = 6

Call the plguins chat command handler.

ScheduledJob = 7

Call the plguins scheduled job handler.

Implementations

impl InstructionKind

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of InstructionKind.

pub fn from_i32(value: i32) -> Option<InstructionKind>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a InstructionKind, or None if value is not a valid variant.

impl InstructionKind

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

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for InstructionKind

fn clone(&self) -> InstructionKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionKind

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

Formats the value using the given formatter.

impl Default for InstructionKind

fn default() -> InstructionKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstructionKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InstructionKind> for i32

fn from(value: InstructionKind) -> i32

Converts to this type from the input type.

impl Hash for InstructionKind

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 InstructionKind

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for InstructionKind

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<InstructionKind, UnknownEnumValue>

Performs the conversion.

impl Copy for InstructionKind

impl Eq for InstructionKind

impl StructuralPartialEq for InstructionKind