Struct Example

pub struct Example {
    pub name: String,
    pub display_name: String,
    pub manifest_path: String,
    pub kind: TargetKind,
    pub extended: bool,
}

Represents an example or binary that can be executed using cargo-e.

This struct holds metadata about a runnable target within a Rust project.

Fields

• name: The actual name of the target (e.g., "hello_world").
• display_name: A formatted name used for display purposes.
• manifest_path: The path to the Cargo.toml file defining the target.
• kind: Specifies whether the target is an example or a binary.
• extended: Indicates whether the example is located in an extended directory.

Example

use cargo_e::{Example, TargetKind};

let example = Example {
    name: "demo".to_string(),
    display_name: "Demo Example".to_string(),
    manifest_path: "examples/demo/Cargo.toml".to_string(),
    kind: TargetKind::Example,
    extended: true,
};

assert_eq!(example.name, "demo");
assert!(example.extended);

Fields

name: String

display_name: String

manifest_path: String

kind: TargetKind

extended: bool

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl Ord for Example

fn cmp(&self, other: &Example) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Example

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Example

fn partial_cmp(&self, other: &Example) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Example

impl StructuralPartialEq for Example