How to make a local dependency depend on a feature in Cargo?

Question

Given this small library which uses local crates in subdirectories, how would I make one of the dependencies optional, depending on if a feature is enabled?

[package]
name = "image_load"
description = "Small wrapper for image reading API's."
version = "0.1.0"

[features]

default = ["use_png"]

[dependencies]

[dependencies.image_load_ppm]
path = "ppm"

# How to make this build _only_ when 'use_png' feature is enabled?
[dependencies.image_load_png]
path = "png"

While I read the documentation, this shows how to have optional external dependencies. In the example above I'm using a local subdirectory, which I want to build, or not - based on a feature.

How can I make image_load_png only build when the use_png feature is enabled.

It's under the comment # A list of all of the optional dependencies. — Shepmaster
– Shepmaster, Commented Sep 28, 2016 at 13:39
@Shepmaster, yes, I read this. The difference is my dependency is local, instead of an optional external crate, the difference in syntax threw me. Updated the question to make this clear. — ideasman42
– ideasman42, Commented Sep 28, 2016 at 20:43

Shepmaster · Accepted Answer · 2016-09-28 13:40:55Z

6

This can be done by adding the following:

[package]
name = "image_load"
version = "0.1.0"
description = "Small wrapper for image reading API's."

[features]

default = ["use_png"]
use_png = ["image_load_png"]  # <-- new line

[dependencies]

[dependencies.image_load_ppm]
path = "ppm"

[dependencies.image_load_png]
path = "png"
optional = true  # <-- new line

Using the crate can be optional.

e.g.:

#[cfg(feature = "use_png")]  // <-- new line
extern crate image_load_png;

edited Sep 28, 2016 at 13:40

Shepmaster

442k118 gold badges1.3k silver badges1.5k bronze badges

answered Sep 28, 2016 at 1:18

ideasman42

49.7k54 gold badges232 silver badges368 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Community · Accepted Answer · 2017-05-23 12:19:29Z

1

Dependencies marked as optional double as features. However, if you want a feature with a different name, you'll have to define it manually.

For instance, if you mark the dependency image_load_png as optional, then image_load_png will only be compiled if the image_load_png feature is enabled. You can test for the feature being enabled in the Rust code just like any other feature.

[dependencies.image_load_png]
path = "png"
optional = true

edited May 23, 2017 at 12:19

CommunityBot

11 silver badge

answered Sep 29, 2016 at 0:32

Francis Gagné

67.1k13 gold badges202 silver badges172 bronze badges

Collectives™ on Stack Overflow

How to make a local dependency depend on a feature in Cargo?

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related