Skip to main content

ExportFormat

Enum ExportFormat 

Source
pub enum ExportFormat {
    Bash,
    Makefile,
    Markdown,
    GithubAction,
    GitlabCi,
    Dockerfile,
    Circleci,
}
Expand description

Available export formats for sessions.

Variants§

§

Bash

Bash shell script with set -e

§

Makefile

Makefile with command targets

§

Markdown

Markdown documentation with code blocks

§

GithubAction

GitHub Actions workflow YAML

§

GitlabCi

GitLab CI/CD pipeline YAML

§

Dockerfile

Dockerfile with RUN commands

§

Circleci

CircleCI configuration YAML

Implementations§

Source§

impl ExportFormat

Source

pub fn description(&self) -> &'static str

Returns a one-line description for this format.

Source

pub fn name(&self) -> &'static str

Returns the kebab-case name for this format as clap displays it.

Source

pub fn all_names() -> Vec<&'static str>

Returns all format names as clap would display them (kebab-case).

Uses clap’s ValueEnum::value_variants() to iterate all variants, ensuring the list stays in sync with the enum definition.

Source

pub fn all_with_descriptions() -> Vec<(&'static str, &'static str)>

Returns (name, description) pairs for all formats.

Useful for –help text and error messages.

Source

pub fn suggest(invalid: &str) -> Option<String>

Suggests the closest format name for an invalid input using fuzzy matching.

Returns Some(name) if a format name is within Levenshtein edit distance 2 of the input, otherwise None.

Trait Implementations§

Source§

impl Clone for ExportFormat

Source§

fn clone(&self) -> ExportFormat

Returns a duplicate 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 ExportFormat

Source§

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

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

impl ValueEnum for ExportFormat

Source§

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.
Source§

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value. Read more
Source§

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

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> 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.