Struct FsEditor 

pub struct FsEditor<P: Marshallable> { /* private fields */ }

An editor for a file

Implementations

impl<P: Marshallable> FsEditor<P>

pub fn from_env( path: &Path, allow_generated: bool, allow_reformatting: Option<bool>, ) -> Result<Self, EditorError>

Create a new editor, with preferences being read from the environment

pub fn new( path: &Path, allow_generated: bool, allow_reformatting: bool, ) -> Result<Self, EditorError>

Create a new editor

Trait Implementations

impl<M: Marshallable> DerefMut for FsEditor<M>

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

Mutably dereferences the value.

impl<P: Marshallable> Editor<P> for FsEditor<P>

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<M: Marshallable> Deref for FsEditor<M>

type Target = M

The resulting type after dereferencing.

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

Dereferences the value.