Struct Deb822 

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

An AST node representing a Deb822.

Implementations

impl Deb822

pub fn new() -> Deb822

Create a new empty deb822 file.

pub fn parse(text: &str) -> Parse<Deb822>

Parse deb822 text, returning a Parse result

pub fn wrap_and_sort( &self, sort_paragraphs: Option<&dyn Fn(&Paragraph, &Paragraph) -> Ordering>, wrap_and_sort_paragraph: Option<&dyn Fn(&Paragraph) -> Paragraph>, ) -> Deb822

Provide a formatter that can handle indentation and trailing separators

Arguments

• control - The control file to format
• indentation - The indentation to use
• immediate_empty_line - Whether the value should always start with an empty line. If true, then the result becomes something like “Field:\n value”. This parameter only applies to the values that will be formatted over more than one line.
• max_line_length_one_liner - If set, then this is the max length of the value if it is crammed into a “one-liner” value. If the value(s) fit into one line, this parameter will overrule immediate_empty_line.
• sort_paragraphs - If set, then this function will sort the paragraphs according to the given function.
• sort_entries - If set, then this function will sort the entries according to the given function.

pub fn paragraphs(&self) -> impl Iterator<Item = Paragraph>

Returns an iterator over all paragraphs in the file.

pub fn insert_paragraph(&mut self, index: usize) -> Paragraph

Insert a new empty paragraph into the file after specified index.

Examples

use deb822_edit::{Deb822, Paragraph};
let mut d: Deb822 = vec![
    vec![("Foo", "Bar"), ("Baz", "Qux")].into_iter().collect(),
    vec![("A", "B"), ("C", "D")].into_iter().collect(),
]
.into_iter()
.collect();
let mut p = d.insert_paragraph(0);
p.set("Foo", "Baz");
assert_eq!(d.to_string(), "Foo: Baz\n\nFoo: Bar\nBaz: Qux\n\nA: B\nC: D\n");
let mut another = d.insert_paragraph(1);
another.set("Y", "Z");
assert_eq!(d.to_string(), "Foo: Baz\n\nY: Z\n\nFoo: Bar\nBaz: Qux\n\nA: B\nC: D\n");

pub fn remove_paragraph(&mut self, index: usize)

Remove the paragraph at the specified index from the file.

Examples

use deb822_edit::Deb822;
let mut d: Deb822 = vec![
    vec![("Foo", "Bar"), ("Baz", "Qux")].into_iter().collect(),
    vec![("A", "B"), ("C", "D")].into_iter().collect(),
]
.into_iter()
.collect();
d.remove_paragraph(0);
assert_eq!(d.to_string(), "A: B\nC: D\n");
d.remove_paragraph(0);
assert_eq!(d.to_string(), "");

pub fn add_paragraph(&mut self) -> Paragraph

Add a new empty paragraph to the end of the file.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Read a deb822 file from the given path.

pub fn from_file_relaxed( path: impl AsRef<Path>, ) -> Result<(Self, Vec<String>), Error>

Read a deb822 file from the given path, ignoring any syntax errors.

pub fn from_str_relaxed(s: &str) -> (Self, Vec<String>)

Parse a deb822 file from a string, allowing syntax errors.

pub fn read<R: Read>(r: R) -> Result<Self, Error>

Read a deb822 file from a Read object.

pub fn read_relaxed<R: Read>(r: R) -> Result<(Self, Vec<String>), Error>

Read a deb822 file from a Read object, allowing syntax errors.

Trait Implementations

impl AstNode for Deb822

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 Deb822

fn clone(&self) -> Deb822

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Deb822

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

Formats the value using the given formatter.

impl Default for Deb822

fn default() -> Self

Returns the “default value” for a type.

impl Display for Deb822

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

Formats the value using the given formatter.

impl FromIterator<Paragraph> for Deb822

fn from_iter<T: IntoIterator<Item = Paragraph>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Deb822

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Deb822

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 Deb822

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

impl StructuralPartialEq for Deb822