Struct graphql_client_codegen::GraphQLClientCodegenOptions

pub struct GraphQLClientCodegenOptions {
    pub mode: CodegenMode,
    pub operation_name: Option<String>,
    pub struct_name: Option<String>,
    // some fields omitted
}

Used to configure code generation.

Fields

mode: CodegenMode

Which context is this code generation effort taking place.

operation_name: Option<String>

Name of the operation we want to generate code for. If it does not match, we use all queries.

struct_name: Option<String>

The name of implemention target struct.

Methods

impl GraphQLClientCodegenOptions

pub fn new(mode: CodegenMode) -> GraphQLClientCodegenOptions

Creates an empty options object with default params. It probably wants to be configured.

pub fn set_query_file(&mut self, path: PathBuf)

A path to a file to include in the module to force Cargo to take into account changes in the query files when recompiling.

pub fn additional_derives(&self) -> Option<&str>

Comma-separated list of additional traits we want to derive.

pub fn set_additional_derives(&mut self, additional_derives: String)

Comma-separated list of additional traits we want to derive.

pub fn set_deprecation_strategy(
    &mut self,
    deprecation_strategy: DeprecationStrategy
)

The deprecation strategy to adopt.

pub fn set_module_visibility(&mut self, visibility: Visibility)

Target module visibility.

pub fn set_struct_name(&mut self, struct_name: String)

The name of implemention target struct.

pub fn set_operation_name(&mut self, operation_name: String)

Name of the operation we want to generate code for. If none is selected, it means all operations.

pub fn schema_file(&self) -> Option<&Path>

A path to a file to include in the module to force Cargo to take into account changes in the schema files when recompiling.

pub fn query_file(&self) -> Option<&Path>

A path to a file to include in the module to force Cargo to take into account changes in the query files when recompiling.

pub fn set_struct_ident(&mut self, ident: Ident)

The identifier to use when referring to the struct implementing GraphQLQuery, if any.

pub fn struct_ident(&self) -> Option<&Ident>

The identifier to use when referring to the struct implementing GraphQLQuery, if any.

Trait Implementations

impl Debug for GraphQLClientCodegenOptions

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

Formats the value using the given formatter.