Struct Header

pub struct Header<C: HeaderChecker> { /* private fields */ }

A file header to check for, or add to, files.

Implementations

impl<C: HeaderChecker> Header<C>

pub fn new(checker: C, header: String) -> Self

Construct a new Header with the checker used to determine if the header is already present, and the plain header text to add.

header does not need to have applicable comment syntax, etc, as that will be added for each file type encountered.

pub fn header_present(&self, input: &mut impl Read) -> Result<bool>

Return true if the file has the desired header, false otherwise.

pub fn add_header_if_missing(&self, p: &Path) -> Result<bool, AddHeaderError>

Add the header, with appropriate formatting for the type of file indicated by p’s extension, if the header is not already present. Returns true if the header was added.

pub fn delete_header_if_present( &self, p: &Path, ) -> Result<bool, DeleteHeaderError>

Delete the header, with appropriate formatting for the type of file indicated by p’s extension, if the header is already present. Returns true if the header was deleted.

Trait Implementations

impl<C: Clone + HeaderChecker> Clone for Header<C>

fn clone(&self) -> Header<C>

Returns a copy of the value.

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

Performs copy-assignment from source.