Struct cargo_rx::ExampleFile

pub struct ExampleFile {
    pub name: String,
    pub path: PathBuf,
    pub path_type: ExampleType,
    pub required_features: Option<String>,
}

Represents an example file in a Cargo project.

Fields

name: String

The file stem (i.e. filename without the extension) for an example file, or the folder name in the case of a main.rs example within a sub-folder.

path: PathBuf

Path to example file

path_type: ExampleType

Type of example file

required_features: Option<String>

A space-separated list of required features for the example (or binary) to run.

The required-features field specifies which features the product needs in order to be built.

If any of the required features are not selected, the product will be skipped. This is only relevant for the [[bin]], [[bench]], [[test]], and [[example]] sections, it has no effect on [lib].

Implementations

impl ExampleFile

pub fn new<P: AsRef<Path>>( root: &Path, name: String, path: P, required_features: Option<String> ) -> Self

Create an ExampleFile from a example name, a (possibly relative) path, and a list of required features for the example.

Arguments

• root - The current working directory, used in case the path is relative.
• name - The name of the example file, without the extension
• path - The path to the example file. This can be a relative path and contain characters such as . and .. for instance.

Trait Implementations

impl Clone for ExampleFile

fn clone(&self) -> ExampleFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleFile

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

Formats the value using the given formatter.

impl Hash for ExampleFile

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ExampleFile

order a sequence of ExampleFiles by the name field.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ExampleFile> for ExampleFile

Determine equality and hash using the path field.

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<PathBuf> for ExampleFile

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<ExampleFile> for ExampleFile

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<PathBuf> for ExampleFile

fn try_from(path: PathBuf) -> StdResult<Self, Self::Error>

Try to create an ExampleFile from a PathBuf object.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for ExampleFile

impl StructuralEq for ExampleFile