Struct gherkin_rust::Feature

pub struct Feature {
    pub keyword: String,
    pub name: String,
    pub description: Option<String>,
    pub background: Option<Background>,
    pub scenarios: Vec<Scenario>,
    pub rules: Vec<Rule>,
    pub tags: Vec<String>,
    pub span: Span,
    pub position: LineCol,
    pub path: Option<PathBuf>,
}

A feature

Fields

keyword: String

The raw keyword used in the original source.

name: String

The name of the feature.

description: Option<String>

The description of the feature, if found.

background: Option<Background>

The background of the feature, if found.

scenarios: Vec<Scenario>

The scenarios for the feature.

rules: Vec<Rule>

The rules for the feature.

tags: Vec<String>

The tags for the feature if provided.

span: Span

The (start, end) offset the feature directive was found in the .feature file.

position: LineCol

The (line, col) position the feature directive was found in the .feature file.

path: Option<PathBuf>

The path supplied for the parsed Feature, if known.

Implementations

impl Feature

pub fn builder() -> FeatureBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building Feature. On the builder, call .keyword(...), .name(...), .description(...)(optional), .background(...)(optional), .scenarios(...)(optional), .rules(...)(optional), .tags(...)(optional), .span(...)(optional), .position(...)(optional), .path(...)(optional) to set the values of the fields (they accept Into values). Finally, call .build() to create the instance of Feature.

impl Feature

pub fn parse_path<P: AsRef<Path>>(
    path: P,
    env: GherkinEnv
) -> Result<Feature, ParseFileError>

pub fn parse<S: AsRef<str>>(
    input: S,
    env: GherkinEnv
) -> Result<Feature, ParseError>

Trait Implementations

impl Clone for Feature

fn clone(&self) -> Feature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Feature

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

Formats the value using the given formatter.

impl Eq for Feature

impl Hash for Feature

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 Feature

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

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

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

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

This method tests for !=.

impl PartialOrd<Feature> for Feature

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

impl StructuralPartialEq for Feature