Enum StepKeyword 

pub enum StepKeyword {
    Given,
    When,
    Then,
    And,
    But,
}

Keyword used to categorise a step definition.

The enum includes And and But variants for completeness, but feature parsing resolves them against the preceding Given/When/Then using the resolve method.

Variants

Given

Setup preconditions for a scenario.

When

Perform an action when testing behaviour.

Then

Assert the expected outcome of a scenario.

And

Additional conditions that share context with the previous step.

But

Negative or contrasting conditions.

Implementations

impl StepKeyword

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

Return the keyword as a string slice.

Examples

use rstest_bdd_patterns::StepKeyword;

assert_eq!(StepKeyword::Given.as_str(), "Given");
assert_eq!(StepKeyword::And.as_str(), "And");

pub fn resolve(self, prev: &mut Option<StepKeyword>) -> StepKeyword

Resolve conjunctions to the semantic keyword of the previous step.

When the current keyword is And or But, returns the value stored in prev. For primary keywords (Given/When/Then), updates prev and returns the keyword unchanged.

Callers typically seed prev with the first primary keyword in a sequence, defaulting to Given when none is found.

Examples

use rstest_bdd_patterns::StepKeyword;

let mut prev = Some(StepKeyword::Given);
assert_eq!(StepKeyword::And.resolve(&mut prev), StepKeyword::Given);
assert_eq!(StepKeyword::When.resolve(&mut prev), StepKeyword::When);
assert_eq!(prev, Some(StepKeyword::When));

Trait Implementations

impl Clone for StepKeyword

fn clone(&self) -> StepKeyword

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepKeyword

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

Formats the value using the given formatter.

impl FromStr for StepKeyword

type Err = StepKeywordParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<StepKeyword, <StepKeyword as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for StepKeyword

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 PartialEq for StepKeyword

fn eq(&self, other: &StepKeyword) -> 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 TryFrom<&str> for StepKeyword

type Error = StepKeywordParseError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<StepKeyword, <StepKeyword as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<StepType> for StepKeyword

fn try_from( ty: StepType, ) -> Result<StepKeyword, <StepKeyword as TryFrom<StepType>>::Error>

Convert a parsed Gherkin StepType to a StepKeyword.

Gherkin coupling

The gherkin crate (v0.14) defines StepType with only Given, When, and Then variants. Gherkin syntax also includes And and But keywords, but the parser resolves these to the preceding primary keyword before exposing them via StepType.

If a future gherkin release adds new StepType variants (e.g., And, But, or others), the #[expect(unreachable_patterns)] guard below will trigger a compiler warning, prompting an update to this match arm.

type Error = UnsupportedStepType

The type returned in the event of a conversion error.

impl Copy for StepKeyword

impl Eq for StepKeyword

impl StructuralPartialEq for StepKeyword