Enum yash_env::variable::Value

pub enum Value {
    Scalar(String),
    Array(Vec<String>),
}

Value of a variable.

Variants

Scalar(String)

Single string.

Array(Vec<String>)

Array of strings.

Implementations

impl Value

pub fn scalar<S: Into<String>>(value: S) -> Self

Creates a scalar value.

pub fn array<I, S>(values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Creates an array value.

pub fn split(&self) -> impl Iterator<Item = &str>

Splits the value by colons.

If this value is Scalar, the value is separated at each occurrence of colon (:). For Array, each array item is returned without further splitting the value.

let scalar = Value::scalar("/usr/local/bin:/usr/bin:/bin");
let values: Vec<&str> = scalar.split().collect();
assert_eq!(values, ["/usr/local/bin", "/usr/bin", "/bin"]);

let array = Value::array(vec!["foo", "bar"]);
let values: Vec<&str> = array.split().collect();
assert_eq!(values, ["foo", "bar"]);

pub fn quote(&self) -> QuotedValue<'_>

Quotes the value in a format suitable for re-parsing.

This function returns a temporary wrapper of self. To obtain a string representation of the quoted value, you can use the Display or Into<Cow<str>> implementation for the returned object.

See yash_quote for details of quoting.

let scalar = Value::scalar("foo bar");
assert_eq!(scalar.quote().to_string(), "'foo bar'");
let array = Value::array(vec!["1", "", "'\\'"]);
assert_eq!(array.quote().to_string(), r#"(1 '' "'\\'")"#);

Trait Implementations

impl AsRef<Value> for QuotedValue<'_>

Extracts the wrapped reference to the value.

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'a> From<&'a Value> for Expansion<'a>

fn from(value: &'a Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Value> for QuotedValue<'a>

Wraps a value in QuotedValue.

fn from(value: &'a Value) -> Self

Converts to this type from the input type.

impl From<&str> for Value

Converts a string slice to a scalar value.

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Value

Converts a string into a scalar value.

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Value> for Expansion<'static>

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for Value

Converts a vector of strings into an array value.

fn from(values: Vec<String>) -> Self

Converts to this type from the input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> 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 Eq for Value

impl StructuralPartialEq for Value