Skip to main content

Section

Struct Section 

Source
pub struct Section(/* private fields */);
Expand description

A section in a systemd unit file (e.g., [Unit], [Service])

Implementations§

Source§

impl Section

Source

pub fn new(name: &str) -> Section

Create a new section with the given name

Source

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

Get the name of the section

Source

pub fn entries(&self) -> impl Iterator<Item = Entry>

Get all entries in the section

Source

pub fn get(&self, key: &str) -> Option<String>

Get a specific entry by key

Source

pub fn get_all(&self, key: &str) -> Vec<String>

Get all values for a key (systemd allows multiple entries with the same key)

Source

pub fn set(&mut self, key: &str, value: &str)

Set a value for a key (replaces the first occurrence or adds if it doesn’t exist)

Source

pub fn add(&mut self, key: &str, value: &str)

Add a value for a key (appends even if the key already exists)

Source

pub fn insert_at(&mut self, index: usize, key: &str, value: &str)

Insert a value at a specific position (index is among entries only, not all nodes)

If the index is greater than or equal to the number of entries, the entry will be appended at the end.

§Example
let input = r#"[Unit]
Description=Test Service
After=network.target
"#;
let unit = SystemdUnit::from_str(input).unwrap();
{
    let mut section = unit.get_section("Unit").unwrap();
    section.insert_at(1, "Wants", "foo.service");
}

let section = unit.get_section("Unit").unwrap();
let entries: Vec<_> = section.entries().collect();
assert_eq!(entries[0].key(), Some("Description".to_string()));
assert_eq!(entries[1].key(), Some("Wants".to_string()));
assert_eq!(entries[2].key(), Some("After".to_string()));
Source

pub fn insert_before(&mut self, existing_key: &str, key: &str, value: &str)

Insert a value before the first entry with the specified key

If no entry with the specified key exists, this method does nothing.

§Example
let input = r#"[Unit]
Description=Test Service
After=network.target
"#;
let unit = SystemdUnit::from_str(input).unwrap();
{
    let mut section = unit.get_section("Unit").unwrap();
    section.insert_before("After", "Wants", "foo.service");
}

let section = unit.get_section("Unit").unwrap();
let entries: Vec<_> = section.entries().collect();
assert_eq!(entries[0].key(), Some("Description".to_string()));
assert_eq!(entries[1].key(), Some("Wants".to_string()));
assert_eq!(entries[2].key(), Some("After".to_string()));
Source

pub fn insert_after(&mut self, existing_key: &str, key: &str, value: &str)

Insert a value after the first entry with the specified key

If no entry with the specified key exists, this method does nothing.

§Example
let input = r#"[Unit]
Description=Test Service
After=network.target
"#;
let unit = SystemdUnit::from_str(input).unwrap();
{
    let mut section = unit.get_section("Unit").unwrap();
    section.insert_after("Description", "Wants", "foo.service");
}

let section = unit.get_section("Unit").unwrap();
let entries: Vec<_> = section.entries().collect();
assert_eq!(entries[0].key(), Some("Description".to_string()));
assert_eq!(entries[1].key(), Some("Wants".to_string()));
assert_eq!(entries[2].key(), Some("After".to_string()));
Source

pub fn set_list(&mut self, key: &str, values: &[&str])

Set a space-separated list value for a key

This is a convenience method for setting list-type directives (e.g., Wants=, After=). The values will be joined with spaces.

§Example
section.set_list("Wants", &["foo.service", "bar.service"]);
// Results in: Wants=foo.service bar.service
Source

pub fn get_list(&self, key: &str) -> Vec<String>

Get a value parsed as a space-separated list

This is a convenience method for getting list-type directives. If the key doesn’t exist, returns an empty vector.

Source

pub fn get_bool(&self, key: &str) -> Option<bool>

Get a value parsed as a boolean

Returns None if the key doesn’t exist or if the value is not a valid boolean.

§Example
let unit = SystemdUnit::from_str("[Service]\nRemainAfterExit=yes\n").unwrap();
let section = unit.get_section("Service").unwrap();
assert_eq!(section.get_bool("RemainAfterExit"), Some(true));
Source

pub fn set_bool(&mut self, key: &str, value: bool)

Set a boolean value for a key

This is a convenience method that formats the boolean as “yes” or “no”.

§Example
let unit = SystemdUnit::from_str("[Service]\n").unwrap();
let mut section = unit.get_section("Service").unwrap();
section.set_bool("RemainAfterExit", true);
assert_eq!(section.get("RemainAfterExit"), Some("yes".to_string()));
Source

pub fn remove(&mut self, key: &str)

Remove the first entry with the given key

Source

pub fn remove_all(&mut self, key: &str)

Remove all entries with the given key

Source

pub fn remove_value(&mut self, key: &str, value_to_remove: &str)

Remove a specific value from entries with the given key

This is useful for multi-value fields like After=, Wants=, etc. It handles space-separated values within a single entry and removes entire entries if they only contain the target value.

§Example
let input = r#"[Unit]
After=network.target syslog.target
After=remote-fs.target
"#;
let unit = SystemdUnit::from_str(input).unwrap();
{
    let mut section = unit.sections().next().unwrap();
    section.remove_value("After", "syslog.target");
}

let section = unit.sections().next().unwrap();
let all_after = section.get_all("After");
assert_eq!(all_after.len(), 2);
assert_eq!(all_after[0], "network.target");
assert_eq!(all_after[1], "remote-fs.target");
Source

pub fn remove_entries_where<F>(&mut self, predicate: F)
where F: FnMut(&str, &str) -> bool,

Remove entries matching a predicate

This provides a flexible way to remove entries based on arbitrary conditions. The predicate receives the entry’s key and value and should return true for entries that should be removed.

§Example
let input = r#"[Unit]
After=network.target syslog.target
Wants=foo.service
After=remote-fs.target
"#;
let unit = SystemdUnit::from_str(input).unwrap();
{
    let mut section = unit.sections().next().unwrap();
    section.remove_entries_where(|key, value| {
        key == "After" && value.split_whitespace().any(|v| v == "syslog.target")
    });
}

let section = unit.sections().next().unwrap();
let all_after = section.get_all("After");
assert_eq!(all_after.len(), 1);
assert_eq!(all_after[0], "remote-fs.target");
assert_eq!(section.get("Wants"), Some("foo.service".to_string()));
Source

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

Get the raw syntax node

Source

pub fn line(&self) -> usize

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

Source

pub fn column(&self) -> usize

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

Source

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§

Source§

impl AstNode for Section

Source§

type Language = Lang

Source§

fn can_cast(kind: SyntaxKind) -> bool

Source§

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

Source§

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

Source§

fn clone_for_update(&self) -> Self
where Self: Sized,

Source§

fn clone_subtree(&self) -> Self
where Self: Sized,

Source§

impl Clone for Section

Source§

fn clone(&self) -> Section

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Section

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Section

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Section

Source§

fn eq(&self, other: &Section) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Section

Source§

impl StructuralPartialEq for Section

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.