Struct Config

Source
pub struct Config {
Show 13 fields pub file_header_comment: String, pub class: String, pub class_constants: Option<String>, pub dll_name: String, pub namespace_mappings: NamespaceMappings, pub namespace_id: String, pub visibility_types: CSharpVisibility, pub unroll_struct_arrays: bool, pub write_types: WriteTypes, pub use_unsafe: Unsafe, pub rename_symbols: bool, pub debug: bool, pub param_slice_type: ParamSliceType,
}
Expand description

Configures C# code generation.

Fields§

§file_header_comment: String

The file header, e.g., // (c) My Company.

§class: String

Name of static class for Interop methods, e.g., Interop.

§class_constants: Option<String>

Name of static class for Interop constants, e.g., Interop. If None then [Self.class] is used

§dll_name: String

DLL to load, e.g., my_library.

§namespace_mappings: NamespaceMappings

Maps which namespace id belongs into which FQN (e.g., “common” => “MyCompany.Common”).

§namespace_id: String

Namespace ID of this namespace to write (default “”).

§visibility_types: CSharpVisibility

Sets the visibility access modifiers for generated types.

§unroll_struct_arrays: bool

Whether, say, a x: [u8; 3] should become 3 x0: u8, ... instead.

If this is not set, interop generation with arrays in structs will fail. This is a somewhat open issue w.r.t Unity-sans-unsafe support and feedback would be greatly welcome!

§write_types: WriteTypes

Which types to write.

§use_unsafe: Unsafe

If enabled bindings will use C# unsafe for increased performance; but will need to be enabled in C# project settings to work.

§rename_symbols: bool

Generate functions and field names matching C# conventions, instead of mapping them 1:1 with Rust.

§debug: bool

Also generate markers for easier debugging

§param_slice_type: ParamSliceType

If signatures that normally use arrays should instead use span and readonly span. Requires use_unsafe, as pinning spans requires the fixed keyword.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.