Struct ExportSettings 

pub struct ExportSettings {
    pub format: ExportFormat,
    pub module_roots: Vec<String>,
    pub module_depth: usize,
    pub children: ChildIncludeMode,
    pub min_code: usize,
    pub max_rows: usize,
    pub redact: RedactMode,
    pub meta: bool,
    pub strip_prefix: Option<String>,
}

Settings for file-level export (tokmd export).

Fields

format: ExportFormat

Output format.

module_roots: Vec<String>

Module roots (see ModuleSettings).

module_depth: usize

Module depth (see ModuleSettings).

children: ChildIncludeMode

How to handle embedded languages.

min_code: usize

Drop rows with fewer than N code lines.

max_rows: usize

Stop after emitting N rows (0 = unlimited).

redact: RedactMode

Redaction mode.

meta: bool

Include a meta record.

strip_prefix: Option<String>

Strip this prefix from paths.

Trait Implementations

impl Clone for ExportSettings

fn clone(&self) -> ExportSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExportSettings

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

Formats the value using the given formatter.

impl Default for ExportSettings

fn default() -> ExportSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExportSettings

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExportSettings, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExportSettings

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.