Struct SshConfigFile 

pub struct SshConfigFile {
    pub elements: Vec<ConfigElement>,
    pub path: PathBuf,
}

Represents the entire SSH config file as a sequence of elements. Preserves the original structure for round-trip fidelity.

Fields

elements: Vec<ConfigElement>

path: PathBuf

Implementations

impl SshConfigFile

pub fn host_entries(&self) -> Vec<HostEntry>

Get all host entries as convenience views (including from Include files).

pub fn has_host(&self, alias: &str) -> bool

Check if a host alias already exists (including in Include files). Walks the element tree directly without building HostEntry structs.

pub fn add_host(&mut self, entry: &HostEntry)

Add a new host entry to the config.

pub fn update_host(&mut self, old_alias: &str, entry: &HostEntry)

Update an existing host entry by alias. Merges changes into the existing block, preserving unknown directives.

pub fn set_host_tags(&mut self, alias: &str, tags: &[String])

Set tags on a host block by alias.

pub fn delete_host(&mut self, alias: &str)

Delete a host entry by alias.

pub fn delete_host_undoable( &mut self, alias: &str, ) -> Option<(ConfigElement, usize)>

Delete a host and return the removed element and its position for undo. Does NOT collapse blank lines so the position stays valid for re-insertion.

pub fn insert_host_at(&mut self, element: ConfigElement, position: usize)

Insert a host block at a specific position (for undo).

pub fn swap_hosts(&mut self, alias_a: &str, alias_b: &str) -> bool

Swap two host blocks in the config by alias. Returns true if swap was performed.

impl SshConfigFile

pub fn parse(path: &Path) -> Result<Self>

Parse an SSH config file from the given path. Preserves all formatting, comments, and unknown directives for round-trip fidelity.

pub fn parse_content(content: &str) -> Vec<ConfigElement>

Parse SSH config content from a string (without Include resolution). Used by tests to create SshConfigFile from inline strings.

impl SshConfigFile

pub fn write(&self) -> Result<()>

Write the config back to disk. Creates a backup before writing and uses atomic write (temp file + rename).

pub fn serialize(&self) -> String

Serialize the config to a string.

Trait Implementations

impl Clone for SshConfigFile

fn clone(&self) -> SshConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SshConfigFile

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

Formats the value using the given formatter.