Struct gherkin::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. 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.

const 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<'de> Deserialize<'de> for Feature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__S> GraphQLObjectType<__S> for Featurewhere
    __S: ScalarValue,

fn mark()

An arbitrary function without meaning.

impl<__S> GraphQLType<__S> for Featurewhere
    __S: ScalarValue,

fn name(_: &Self::TypeInfo) -> Option<&'static str>

Returns name of this GraphQLType to expose.

fn meta<'r>(
    info: &Self::TypeInfo,
    registry: &mut Registry<'r, __S>
) -> MetaType<'r, __S>where
    __S: 'r,

Returns MetaType representing this GraphQLType.

impl<__S> GraphQLValue<__S> for Featurewhere
    __S: ScalarValue,

type Context = ()

Context type for this GraphQLValue.

type TypeInfo = ()

Type that may carry additional schema information for this GraphQLValue.

fn type_name<'__i>(&self, info: &'__i Self::TypeInfo) -> Option<&'__i str>

Returns name of the GraphQLType exposed by this GraphQLValue.

fn resolve_field(
    &self,
    _info: &(),
    field: &str,
    args: &Arguments<'_, __S>,
    executor: &Executor<'_, '_, Self::Context, __S>
) -> ExecutionResult<__S>

Resolves the value of a single field on this GraphQLValue.

fn concrete_type_name(&self, _: &Self::Context, _: &Self::TypeInfo) -> String

Returns the concrete GraphQLType name for this GraphQLValue being an interface, an union or an object.

fn resolve_into_type(
    &self,
    info: &Self::TypeInfo,
    type_name: &str,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, '_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolves this GraphQLValue (being an interface or an union) into a concrete downstream object type.

fn resolve(
    &self,
    info: &Self::TypeInfo,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, '_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolves the provided selection_set against this GraphQLValue.

impl<__S> GraphQLValueAsync<__S> for Featurewhere
    __S: ScalarValue,
    __S: Send + Sync,
    Self: Sync,

fn resolve_field_async<'b>(
    &'b self,
    info: &'b Self::TypeInfo,
    field: &'b str,
    args: &'b Arguments<'_, __S>,
    executor: &'b Executor<'_, '_, Self::Context, __S>
) -> BoxFuture<'b, ExecutionResult<__S>>where
    __S: Send + Sync,

Resolves the value of a single field on this GraphQLValueAsync.

fn resolve_into_type_async(
    &'a self,
    info: &'a Self::TypeInfo,
    type_name: &str,
    selection_set: Option<&'a [Selection<'a, S>]>,
    executor: &'a Executor<'a, 'a, Self::Context, S>
) -> Pin<Box<dyn Future<Output = Result<Value<S>, FieldError<S>>> + Send + 'a, Global>>

Resolves this GraphQLValueAsync (being an interface or an union) into a concrete downstream object type.

fn resolve_async(
    &'a self,
    info: &'a Self::TypeInfo,
    selection_set: Option<&'a [Selection<'_, S>]>,
    executor: &'a Executor<'_, '_, Self::Context, S>
) -> Pin<Box<dyn Future<Output = Result<Value<S>, FieldError<S>>> + Send + 'a, Global>>

Resolves the provided selection_set against this GraphQLValueAsync.

impl Hash for Feature

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,

Feeds a slice of this type into the given Hasher.

impl<__S> IsOutputType<__S> for Featurewhere
    __S: ScalarValue,

fn mark()

An arbitrary function without meaning.

impl Ord for Feature

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

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

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

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

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

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

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

const 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 Serialize for Feature

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

Serialize this value into the given Serde serializer.

impl Eq for Feature

impl StructuralEq for Feature

impl StructuralPartialEq for Feature