[−][src]Trait safer_ffi::headers::Definer
This is supported on
feature="headers"
only.Helper for the generation of C headers.
Defining C headers requires two abstractions:
-
set-like lookup by name, to ensure each type is defined at most once;
-
a
Write
able "out stream", where the headers should be written to.
This trait minimally combines both abstractions, and in exchange offers an
auto-implemented non-overridable
Definer::define_once
()
.
Required methods
fn insert(&mut self, name: &str) -> bool
This is supported on
feature="headers"
only.Must return true
iff an actual insert
happened.
fn out(&mut self) -> &mut dyn Write
This is supported on
feature="headers"
only.Yields a handle to the underlying Write
r
Provided methods
fn define_once(
&mut self,
name: &str,
write_typedef: &mut dyn FnMut(&mut dyn Definer) -> Result<()>
) -> Result<()>
&mut self,
name: &str,
write_typedef: &mut dyn FnMut(&mut dyn Definer) -> Result<()>
) -> Result<()>
This is supported on
feature="headers"
only.Convenience method to perform an .insert()
so
that if it succeeds (thus guaranteeing the call happens for the first
time), it calls write_typedef
on itself.
This method cannot be overriden.