pub struct DocumentationOperations {
pub templates: HashMap<String, DocumentationTemplate>,
pub maintenance_tasks: HashMap<String, MaintenanceTask>,
pub commit_history: Vec<DocumentationCommit>,
}Expand description
Documentation Operations
Fields§
§templates: HashMap<String, DocumentationTemplate>Documentation templates
maintenance_tasks: HashMap<String, MaintenanceTask>Maintenance tasks
commit_history: Vec<DocumentationCommit>Commit history
Implementations§
Source§impl DocumentationOperations
impl DocumentationOperations
Sourcepub fn commit_documentation(
&mut self,
commit: DocumentationCommit,
) -> Result<PublishingResult>
pub fn commit_documentation( &mut self, commit: DocumentationCommit, ) -> Result<PublishingResult>
Commit documentation updates to repository
Sourcepub fn track_coverage(&mut self, task: MaintenanceTask) -> Result<()>
pub fn track_coverage(&mut self, task: MaintenanceTask) -> Result<()>
Track documentation coverage and gaps
Sourcepub fn add_template(&mut self, template: DocumentationTemplate) -> Result<()>
pub fn add_template(&mut self, template: DocumentationTemplate) -> Result<()>
Support documentation templates
Sourcepub fn get_template(&self, name: &str) -> Option<&DocumentationTemplate>
pub fn get_template(&self, name: &str) -> Option<&DocumentationTemplate>
Get template by name
Sourcepub fn render_template(
&self,
name: &str,
values: &HashMap<String, String>,
) -> Result<String>
pub fn render_template( &self, name: &str, values: &HashMap<String, String>, ) -> Result<String>
Render template with values
Sourcepub fn get_maintenance_tasks(&self) -> Vec<&MaintenanceTask>
pub fn get_maintenance_tasks(&self) -> Vec<&MaintenanceTask>
Get all maintenance tasks
Sourcepub fn get_maintenance_task(&self, name: &str) -> Option<&MaintenanceTask>
pub fn get_maintenance_task(&self, name: &str) -> Option<&MaintenanceTask>
Get maintenance task by name
Sourcepub fn update_task_status(
&mut self,
name: &str,
status: MaintenanceStatus,
) -> Result<()>
pub fn update_task_status( &mut self, name: &str, status: MaintenanceStatus, ) -> Result<()>
Update maintenance task status
Sourcepub fn get_commit_history(&self) -> &[DocumentationCommit]
pub fn get_commit_history(&self) -> &[DocumentationCommit]
Get commit history
Sourcepub fn get_latest_commit(&self) -> Option<&DocumentationCommit>
pub fn get_latest_commit(&self) -> Option<&DocumentationCommit>
Get latest commit
Trait Implementations§
Source§impl Clone for DocumentationOperations
impl Clone for DocumentationOperations
Source§fn clone(&self) -> DocumentationOperations
fn clone(&self) -> DocumentationOperations
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DocumentationOperations
impl Debug for DocumentationOperations
Auto Trait Implementations§
impl Freeze for DocumentationOperations
impl RefUnwindSafe for DocumentationOperations
impl Send for DocumentationOperations
impl Sync for DocumentationOperations
impl Unpin for DocumentationOperations
impl UnwindSafe for DocumentationOperations
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more