Struct cage::Target

pub struct Target { /* fields omitted */ }

An Target provides collection of extensions to a project's basic pods. Targets are typically used to represent deployment environments: test, development and production.

(Right now, this is deliberately a very thin wrapper around the name field, suitable for use as key in a BTreeMap. If you add more fields, you'll probably need to remove PartialEq, Eq, PartialOrd, Ord from the derive list, and either implement them manually or redesign the code that uses targets as hash table keys.)

Methods

impl Target

fn new<S>(name: S) -> Target where S: Into<String>

Create a new target with the specified name.

fn name(&self) -> &str

Get the name of this target.

fn is_enabled_by(&self, enable_in_targets: &Option<Vec<String>>) -> bool

Check to see if this target should be included in some operation, given an optional enable_in_targets targets list. If no list is supplied, we'll act as those we were passed a default list including all targets except test.

We have a weird calling convention because our typical callers are invoking us using a member field of a Config struct that they own.

let target = cage::Target::new("development");
assert!(target.is_enabled_by(&None));
assert!(target.is_enabled_by(&Some(vec!["development".to_owned()])));
assert!(!target.is_enabled_by(&Some(vec!["production".to_owned()])));

let test_target = cage::Target::new("test");
assert!(!test_target.is_enabled_by(&None));

fn compose_project_name(&self, project: &Project) -> String

Get a value for docker-compose's -p argument for a given project.

Trait Implementations

impl Debug for Target

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Target

fn clone(&self) -> Target

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Target

fn eq(&self, __arg_0: &Target) -> bool

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

fn ne(&self, __arg_0: &Target) -> bool

This method tests for !=.

impl Eq for Target

impl PartialOrd for Target

fn partial_cmp(&self, __arg_0: &Target) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Target) -> bool

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

fn le(&self, __arg_0: &Target) -> bool

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

fn gt(&self, __arg_0: &Target) -> bool

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

fn ge(&self, __arg_0: &Target) -> bool

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

impl Ord for Target

fn cmp(&self, __arg_0: &Target) -> Ordering

This method returns an Ordering between self and other.