Struct Include 

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

An AST node for $ast

Implementations

impl Include

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

Get the raw path of the include directive

pub fn is_optional(&self) -> bool

Check if this is an optional include (-include or sinclude)

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

Get the parent item of this include directive, if any

Returns Some(MakefileItem) if this include 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
include debug.mk
endif
"#.parse().unwrap();
let cond = makefile.conditionals().next().unwrap();
let inc = cond.if_items().next().unwrap();
// Include's parent is the conditional
assert!(matches!(inc, makefile_lossless::MakefileItem::Include(_)));

pub fn remove(&mut self) -> Result<(), Error>

Remove this include directive from the makefile

This will also remove any preceding comments.

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "include config.mk\nVAR = value\n".parse().unwrap();
let mut inc = makefile.includes().next().unwrap();
inc.remove().unwrap();
assert_eq!(makefile.includes().count(), 0);

pub fn set_path(&mut self, new_path: &str)

Set the path of this include directive

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "include old.mk\n".parse().unwrap();
let mut inc = makefile.includes().next().unwrap();
inc.set_path("new.mk");
assert_eq!(inc.path(), Some("new.mk".to_string()));
assert_eq!(makefile.to_string(), "include new.mk\n");

pub fn set_optional(&mut self, optional: bool)

Make this include optional (change “include” to “-include”)

If the include is already optional, this has no effect.

Example

use makefile_lossless::Makefile;
let mut makefile: Makefile = "include config.mk\n".parse().unwrap();
let mut inc = makefile.includes().next().unwrap();
inc.set_optional(true);
assert!(inc.is_optional());
assert_eq!(makefile.to_string(), "-include config.mk\n");

impl Include

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 Include

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 Include

fn clone(&self) -> Include

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for Include

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

Formats the value using the given formatter.

impl Hash for Include

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 Include

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

impl StructuralPartialEq for Include