Struct safer_ffi::headers::Builder

pub struct Builder<'__, W> { /* private fields */ }

Available on crate feature headers only.

Implementations

impl<'__, W> Builder<'__, W>

pub fn with_guard(self, guard: &'__ str) -> Self

Sets up the name of the ifndef guard of the header file.

It defaults to:

format!("__RUST_{}__", env::var("CARGO_CRATE_NAME")?.replace("-", "_").to_ascii_uppercase())

pub fn with_text_after_guard(self, text_after_guard: &'__ str) -> Self

Text included after the include guard of the header file

It defaults to an empty string

pub fn with_banner(self, banner: &'__ str) -> Self

Sets up the banner of the generated C header file.

It defaults to:

concat!(
    "/*! \\file */\n",
    "/*******************************************\n",
    " *                                         *\n",
    " *  File auto-generated by `::safer_ffi`.  *\n",
    " *                                         *\n",
    " *  Do not manually edit this file.        *\n",
    " *                                         *\n",
    " *******************************************/\n",
)

/*! \file */
/*******************************************
 *                                         *
 *  File auto-generated by `::safer_ffi`.  *
 *                                         *
 *  Do not manually edit this file.        *
 *                                         *
 *******************************************/

pub fn with_language(self, language: Language) -> Self

Sets the Language of the generated headers.

It defaults to Language::C.

pub fn with_naming_convention(self, naming_convention: NamingConvention) -> Self

Sets prefix for generated functions, structs & enums

pub fn with_stable_header(self, stable_header: bool) -> Self

Whether to yield a stable header or not (order of defined items guaranteed not to change provided the source code doesn’t change either).

It defaults to true.

impl<'__> Builder<'__, WhereTo>

pub fn to_file(self, filename: impl AsRef<Path>) -> Result<Builder<'__, File>>

Specify the path to the file to be generated.

⚠️ If it already exists, its contents will be overwritten ⚠️

There is no default value here, either .to_file() or .to_writer() need to be called to be able to .generate() the headers.

For more fine-grained control over the “output stream” where the headers will be written to, use .to_writer().

Example

::safer_ffi::headers::builder()
    .to_file("my_header.h")?
    .generate()?

pub fn to_writer<W>(self, out: W) -> Builder<'__, W>where
    W: Write,

Specify the Write “stream” where the headers will be written to.

Example

// Display the headers to the standard output
// (may need the `--nocapture` flag when running the tests)
::safer_ffi::headers::builder()
    .to_writer(::std::io::stdout())
    .generate()?

impl<'__, W: Write> Builder<'__, W>

pub fn generate(self) -> Result<()>

Generate the C header file.

impl Builder<'_, WhereTo>

pub fn generate_with_definer(self, definer: &mut impl Definer) -> Result<()>

More customizable version of .generate().

With this call, one can provide a custom implementation of a Definer, which can be useful for mock tests, mainly.

Trait Implementations

impl<'__, W: Default> Default for Builder<'__, W>

fn default() -> Builder<'__, W>

Returns the “default value” for a type.