Struct gdnative_project_utils::Generator

pub struct Generator { /* fields omitted */ }

A builder type that holds all necessary information about the project to generate files in all the right places.

Implementations

impl Builder

pub fn new() -> Self

Construct a new Builder.

pub fn with_godot_project_dir(&mut self, dir: impl AsRef<Path>)

REQUIRED Set the path to the root of the Godot project.

pub fn godot_project_dir(mut self: Self, dir: impl AsRef<Path>) -> Self

REQUIRED Set the path to the root of the Godot project.

pub fn with_godot_resource_output_dir(&mut self, dir: impl AsRef<Path>)

Set the path to the directory inside the Godot project to which the generates files should be saved.

pub fn godot_resource_output_dir(mut self: Self, dir: impl AsRef<Path>) -> Self

Set the path to the directory inside the Godot project to which the generates files should be saved.

pub fn with_target_dir(&mut self, dir: impl AsRef<Path>)

Set the path to the target directory in which cargo creates build artefacts.

pub fn target_dir(mut self: Self, dir: impl AsRef<Path>) -> Self

Set the path to the target directory in which cargo creates build artefacts.

pub fn with_lib_format(&mut self, lib_format: LibFormat)

Set the type of the GDNativeLibrary Format

pub fn lib_format(mut self: Self, lib_format: LibFormat) -> Self

Set the type of the GDNativeLibrary Format

pub fn with_lib_name(&mut self, name: impl AsRef<str>)

Set the name of the crate.

pub fn lib_name(mut self: Self, name: impl AsRef<str>) -> Self

Set the name of the crate.

pub fn with_build_mode(&mut self, mode: BuildMode)

Set the build mode of the crate.

This will affect the path the gdnlib resource points to.

pub fn build_mode(mut self: Self, mode: BuildMode) -> Self

Set the build mode of the crate.

This will affect the path the gdnlib resource points to.

pub fn build(self, classes: Classes) -> Result<(), Error>

Build and generate files for the crate and all classes.

Panics

This function panics if the godot_project_dir has not been set.

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the "default value" for a type.