Enum YamlAction 

pub enum YamlAction {
    SetField {
        file: PathBuf,
        parent_path: Vec<YamlPathComponent>,
        key: String,
        value: String,
    },
    SetFieldOrdered {
        file: PathBuf,
        parent_path: Vec<YamlPathComponent>,
        key: String,
        value: String,
        field_order: Vec<String>,
    },
    RemoveField {
        file: PathBuf,
        parent_path: Vec<YamlPathComponent>,
        key: String,
    },
    RenameField {
        file: PathBuf,
        parent_path: Vec<YamlPathComponent>,
        from: String,
        to: String,
    },
}

Edits to a YAML file.

A YAML file is a tree of mappings, sequences and scalars; the parent_path field navigates from the top-level document down to the mapping that owns the key being edited. An empty parent_path means the top-level mapping (the common case for Debian’s flat YAML files like debian/upstream/metadata).

Each path component is either a string (mapping key) or an index (sequence position).

Variants

SetField

Set a scalar value at parent_path’s mapping under key. Inserts the key if missing. New keys are appended at the end of the mapping; use SetFieldOrdered to position the new key according to a canonical field order (e.g. DEP-12).

Fields

file: PathBuf

File to edit, relative to the package root.

parent_path: Vec<YamlPathComponent>

Path from the document root to the parent mapping.

key: String

Key to set (string scalar).

value: String

New value (string scalar).

SetFieldOrdered

Like SetField, but when inserting a new key, position it according to field_order. Keys not listed in field_order are placed at the end. A no-op if the key already exists with the requested value.

Fields

file: PathBuf

File to edit, relative to the package root.

parent_path: Vec<YamlPathComponent>

Path from the document root to the parent mapping.

key: String

Key to set (string scalar).

value: String

New value (string scalar).

field_order: Vec<String>

Canonical field order. Keys appearing earlier in this list are placed earlier in the mapping.

RemoveField

Remove a key from the mapping at parent_path.

Fields

file: PathBuf

File to edit, relative to the package root.

parent_path: Vec<YamlPathComponent>

Path from the document root to the parent mapping.

key: String

Key to remove.

RenameField

Rename a key in the mapping at parent_path, preserving its value and position.

Fields

file: PathBuf

File to edit, relative to the package root.

parent_path: Vec<YamlPathComponent>

Path from the document root to the parent mapping.

from: String

Current key name.

to: String

New key name.

Trait Implementations

impl Clone for YamlAction

fn clone(&self) -> YamlAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for YamlAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for YamlAction

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for YamlAction

impl StructuralPartialEq for YamlAction