Skip to main content

Roadmap

Struct Roadmap 

Source
pub struct Roadmap { /* private fields */ }
Expand description

解析后的 ROADMAP.md 文档。

Implementations§

Source§

impl Roadmap

Source

pub fn from_path(path: &Path) -> Result<Self, RoadmapError>

从文件路径解析 ROADMAP.md。

Source

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

从字符串解析 ROADMAP.md。

格式约定(Keep a Changelog 变体):

  • # ROADMAP 作为文档标题(必须)
  • ## [版本号] — 状态 作为版本边界
  • ### 分类 作为类别分组(Added / Fixed / Changed 等)
  • - [ ] 描述 为待办条目,- [x] 描述 为已完成
Source§

impl Roadmap

Source

pub fn versions(&self) -> &[RoadmapVersion]

获取所有版本的规划进度。

Source

pub fn total_done(&self) -> usize

总已完成条目数。

Source

pub fn total_all(&self) -> usize

总条目数。

Source§

impl Roadmap

Source

pub fn validate(&self, scope: &str) -> Vec<RoadmapIssue>

验证 ROADMAP.md 格式规范。

规则:

  • 版本号必须为纯数字 X.Y.Z
  • 分类标题必须使用标准大小写(### Added 而非 ### added
  • checkbox 必须使用标准格式(- [ ]- [x]

scope 参数用于标记问题所属范围(通常传入 scope name)。

Trait Implementations§

Source§

impl Clone for Roadmap

Source§

fn clone(&self) -> Roadmap

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Roadmap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Roadmap

Source§

fn eq(&self, other: &Roadmap) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Roadmap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.