Struct VariableDefinition 

pub struct VariableDefinition(/* private fields */);

An AST node for $ast

Implementations

impl VariableDefinition

pub fn name(&self) -> Option<String>

Get the name of the variable definition

pub fn is_export(&self) -> bool

Check if this variable definition is exported

pub fn assignment_operator(&self) -> Option<String>

Get the assignment operator/flavor used in this variable definition

Returns the operator as a string: “=”, “:=”, “::=”, “:::=”, “+=”, “?=”, or “!=”

Example

use makefile_lossless::Makefile;
let makefile: Makefile = "VAR := value\n".parse().unwrap();
let var = makefile.variable_definitions().next().unwrap();
assert_eq!(var.assignment_operator(), Some(":=".to_string()));

pub fn raw_value(&self) -> Option<String>

Get the raw value of the variable definition

pub fn parent(&self) -> Option<MakefileItem>

Get the parent item of this variable definition, if any

Returns Some(MakefileItem) if this variable has a parent that is a MakefileItem (e.g., a Conditional), or None if the parent is the root Makefile node.

Example

use makefile_lossless::Makefile;

let makefile: Makefile = r#"ifdef DEBUG
VAR = value
endif
"#.parse().unwrap();
let cond = makefile.conditionals().next().unwrap();
let var = cond.if_items().next().unwrap();
// Variable's parent is the conditional
assert!(matches!(var, makefile_lossless::MakefileItem::Variable(_)));

pub fn remove(&mut self)

Remove this variable definition from its parent makefile

This will also remove any preceding comments and up to 1 empty line before the variable.

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "VAR = value\n".parse().unwrap();
let mut var = makefile.variable_definitions().next().unwrap();
var.remove();
assert_eq!(makefile.variable_definitions().count(), 0);

pub fn set_assignment_operator(&mut self, op: &str)

Change the assignment operator of this variable definition while preserving everything else (export prefix, variable name, value, whitespace, etc.)

Arguments

• op - The new operator: “=”, “:=”, “::=”, “:::=”, “+=”, “?=”, or “!=”

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "VAR := value\n".parse().unwrap();
let mut var = makefile.variable_definitions().next().unwrap();
var.set_assignment_operator("?=");
assert_eq!(var.assignment_operator(), Some("?=".to_string()));
assert!(makefile.code().contains("VAR ?= value"));

pub fn set_value(&mut self, new_value: &str)

Update the value of this variable definition while preserving the rest (export prefix, operator, whitespace, etc.)

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "export VAR := old_value\n".parse().unwrap();
let mut var = makefile.variable_definitions().next().unwrap();
var.set_value("new_value");
assert_eq!(var.raw_value(), Some("new_value".to_string()));
assert!(makefile.code().contains("export VAR := new_value"));

impl VariableDefinition

pub fn line(&self) -> usize

Get the line number (0-indexed) where this node starts.

pub fn column(&self) -> usize

Get the column number (0-indexed, in bytes) where this node starts.

pub fn line_col(&self) -> (usize, usize)

Get both line and column (0-indexed) where this node starts. Returns (line, column) where column is measured in bytes from the start of the line.

Trait Implementations

impl AstNode for VariableDefinition

type Language = Lang

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode<Lang>) -> Option<Self>

fn syntax(&self) -> &SyntaxNode<Lang>

fn clone_for_update(&self) -> Self

where Self: Sized,

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for VariableDefinition

fn clone(&self) -> VariableDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for VariableDefinition

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

Formats the value using the given formatter.

impl Hash for VariableDefinition

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 PartialEq for VariableDefinition

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

impl StructuralPartialEq for VariableDefinition