Struct conciliator::edit::TomlEditor

pub struct TomlEditor<T: Serialize + DeserializeOwned> { /* private fields */ }

Wrapper type to Edit something using TOML

Implements Editable itself so it can be used explicitly like con.edit(TomlEditor::new(thing)) or, more conveniently, Editable can be implemented for a particular type to wrap the type automatically when writing con.edit(thing). To this end, the macro edit_as_toml is provided.

Since this uses serde, it requires the type to be Serialize and DeserializeOwned. The trait bound is specifically DeserializeOwned instead of Deserialize because it has to outlive the content of the temporary file and cannot borrow from it.

Implementations

impl<T: Serialize + DeserializeOwned> TomlEditor<T>

pub fn new(thing: T) -> Self

Wrap something to be edited

Trait Implementations

impl<T: Serialize + DeserializeOwned> Edit for TomlEditor<T>

const EXTENSION: &'static str = "toml"

Extension of the temporary file

type T = T

Type returned from editing

type Err = EditError<Error>

Error for Edited::Err

fn write<W: Write>(&self, w: &mut W) -> Result<(), Self::Err>

Write content into the file to be edited

fn read<C>(&self, content: String, con: &C) -> Option<Self::T>

where C: Conciliator + ?Sized,

Read (and parse) the edited file, immediately reporting any errors encountered