Struct gherkin::Rule

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

A rule, as introduced in Gherkin 6.

Fields

keyword: String

The raw keyword used in the original source.

name: String

The name of the scenario.

description: Option<String>

The description of the rule, if found.

background: Option<Background>

The background of the rule, if found.

scenarios: Vec<Scenario>

The parsed scenarios from the rule directive.

tags: Vec<String>

The tags for the rule directive if provided.

span: Span

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

position: LineCol

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

Implementations

impl Rule

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

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

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

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 Rulewhere __S: ScalarValue,

fn mark()

An arbitrary function without meaning.

impl<__S> GraphQLType<__S> for Rulewhere __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 Rulewhere __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 Rulewhere __S: ScalarValue + 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>( &'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>( &'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 Rule

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<__S> IsOutputType<__S> for Rulewhere __S: ScalarValue,

fn mark()

An arbitrary function without meaning.

impl PartialEq<Rule> for Rule

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

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

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 Serialize for Rule

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 Rule

impl StructuralEq for Rule

impl StructuralPartialEq for Rule