Struct build_script::instruction::Instruction

pub struct Instruction {
    pub prefix: Prefix,
    pub name: Option<String>,
    pub value: Value,
}

An instruction. Used as a rusty way to parse arguments in build scripts.

Fields

prefix: Prefix

The prefix. Usually Cargo.

name: Option<String>

The name of the instruction. Most of the time it’s filled in, only when a new mapping new_mapping() is created it’s not.

value: Value

The Value of the Instruction.

Implementations

impl Instruction

pub fn new(name: &str, value: Value) -> Self

Create a new Instruction. 99% of the time this should suffice instead of new_mapping().

pub fn new_mapping(value: Value) -> Self

Create a new Instruction Mapping. Only 1% of the time is this proven useful, instead use new().

Panics

This panics if value is not a Mapping or UnquotedMapping.

pub fn prefix(&mut self, prefix: Prefix) -> &mut Self

Set the prefix.

pub fn name(&mut self, name: &str) -> &mut Self

Set the name.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl Display for Instruction

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

Formats the value using the given formatter.

impl Eq for Instruction

impl Hash for Instruction

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Instruction

fn cmp(&self, other: &Instruction) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Instruction> for Instruction

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Instruction> for Instruction

fn partial_cmp(&self, other: &Instruction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Instruction

impl StructuralPartialEq for Instruction