Skip to main content

CrateConfig

Struct CrateConfig 

Source
pub(crate) struct CrateConfig {
    pub(crate) noexport_postfix: Option<String>,
    pub(crate) source_tags: bool,
    pub(crate) call_attribution: Option<CallAttribution>,
    pub(crate) conversion_error_class: Vec<String>,
    pub(crate) preconditions: Option<bool>,
    pub(crate) roxygen_prose_links: Option<ProseLinks>,
}
Expand description

Crate-wide defaults declared under [package.metadata.miniextendr].

Fields§

§noexport_postfix: Option<String>

noexport_postfix = "...": appended to the Rust name of every noexport / internal free function that sets neither r_name nor its own postfix. Exported functions keep their Rust names.

§source_tags: bool

source_tags = true: every generated roxygen block carries a @source Generated by miniextendr from … provenance tag. Off by default (#1552): the tag collects one paragraph per function on a shared Rd page, and the # Generated from Rust fn … (file:line:col) comment above each wrapper remains the navigation pointer.

§call_attribution: Option<CallAttribution>

call_attribution = "wrapper" | "caller" | "none": the condition-call attribution of every free function that neither takes a Call / CallerCall parameter nor sets call = ... (#1566). caller applies to noexport / internal functions; exported ones keep wrapper. none (#1851) applies to every free function: its conditions carry no call. Unset means the framework default, wrapper.

§conversion_error_class: Vec<String>

conversion_error_class = "..." | ["...", ...]: classes added to every argument-conversion condition of the crate, after the error type’s own RConditionData classes (duplicates skipped) and before the rust_error layering. Empty when unset.

§preconditions: Option<bool>

preconditions = true | false: whether the generated R wrappers of the crate keep their type-derived argument checks (#1566). Below every item-level and per-parameter spelling, above the no-preconditions-default feature (see crate::r_preconditions::resolve_type_checks). Unset means the feature decides, and without it the checks are kept.

§roxygen_prose_links: Option<ProseLinks>

roxygen_prose_links = "strip" | "keep": whether the leading prose of a doc comment keeps its [...] links on its way to @description (see ProseLinks). Unset means the framework default, strip.

Trait Implementations§

Source§

impl Clone for CrateConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CrateConfig

Source§

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

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

impl Default for CrateConfig

Source§

fn default() -> Self

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

impl Eq for CrateConfig

Source§

#[doc(hidden)]
fn assert_fields_are_eq(&self)

🔬This is a nightly-only experimental API. (derive_eq_internals)
1.0.0 (const: unstable) · Source§

#[doc(hidden)]
fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

Source§

impl PartialEq for CrateConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CrateConfig

Auto Trait Implementations§

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> SizeHint for T
where T: ?Sized,

Source§

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)
Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more
Source§

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more
Source§

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an estimate for the number of elements this container like type contains. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes