Struct TemplatedControlEditor

pub struct TemplatedControlEditor { /* private fields */ }

An editor for a control file that may be generated from a template.

This editor will automatically expand the template if it does not exist. It will also automatically update the template if the control file is changed.

Example

use std::path::Path;
use debian_analyzer::control::TemplatedControlEditor;
let td = tempfile::tempdir().unwrap();
let mut editor = TemplatedControlEditor::create(td.path().join("control")).unwrap();
editor.add_source("foo").set_architecture(Some("all"));
editor.commit().unwrap();

Implementations

impl TemplatedControlEditor

pub fn create<P: AsRef<Path>>(control_path: P) -> Result<Self, EditorError>

Create a new control file editor.

pub fn template_type(&self) -> Option<TemplateType>

Return the type of the template used to generate the control file.

pub fn open<P: AsRef<Path>>(control_path: P) -> Result<Self, EditorError>

Open an existing control file.

pub fn new<P: AsRef<Path>>( control_path: P, allow_missing: bool, ) -> Result<Self, EditorError>

Create a new control file editor.

pub fn commit(&self) -> Result<Vec<PathBuf>, EditorError>

Commit the changes to the control file and template.

Methods from Deref<Target = Control>

pub fn as_mut_deb822(&mut self) -> &mut Deb822

Return the underlying deb822 object, mutable

pub fn as_deb822(&self) -> &Deb822

Return the underlying deb822 object

pub fn source(&self) -> Option<Source>

Return the source package

pub fn binaries(&self) -> impl Iterator<Item = Binary>

Iterate over all binary packages

pub fn add_source(&mut self, name: &str) -> Source

Add a new source package

Arguments

• name - The name of the source package

Returns

The newly created source package

Example

use debian_control::lossless::control::Control;
let mut control = Control::new();
let source = control.add_source("foo");
assert_eq!(source.name(), Some("foo".to_owned()));

pub fn add_binary(&mut self, name: &str) -> Binary

Add new binary package

Arguments

• name - The name of the binary package

Returns

The newly created binary package

Example

use debian_control::lossless::control::Control;
let mut control = Control::new();
let binary = control.add_binary("foo");
assert_eq!(binary.name(), Some("foo".to_owned()));

pub fn wrap_and_sort( &mut self, indentation: Indentation, immediate_empty_line: bool, max_line_length_one_liner: Option<usize>, )

Wrap and sort the control file

Arguments

• indentation - The indentation to use
• immediate_empty_line - Whether to add an empty line at the start of multi-line fields
• max_line_length_one_liner - The maximum line length for one-liner fields

Trait Implementations

impl DerefMut for TemplatedControlEditor

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Editor<Control> for TemplatedControlEditor

fn orig_content(&self) -> Option<&[u8]>

The original content, if any - without reformatting

fn updated_content(&self) -> Option<Vec<u8>>

The updated content, if any

fn rewritten_content(&self) -> Option<&[u8]>

The original content, but rewritten with our parser/serializer

fn is_generated(&self) -> bool

Check if the file is generated

fn commit(&self) -> Result<Vec<PathBuf>, EditorError>

Commit the changes

fn has_changed(&self) -> bool

Whether the file has changed

impl Deref for TemplatedControlEditor

type Target = Control

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.