Struct DocItem 

pub struct DocItem {

    pub id: String,
    pub name: String,
    pub doc_type: DocType,
    pub content: String,
    pub signature: Option<String>,
    pub file_path: PathBuf,
    pub line_number: Option<usize>,
    pub parent_id: Option<String>,
    pub children: Vec<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub metadata: HashMap<String, Value>,
    pub related_items: Vec<String>,
    pub tags: Vec<String>,
}

ドキュメント項目

Fields

id: String

ユニークID

name: String

名前

doc_type: DocType

ドキュメントの種類

content: String

ドキュメント本文

signature: Option<String>

署名（関数や型のシグネチャ）

file_path: PathBuf

ファイルパス

line_number: Option<usize>

行番号

parent_id: Option<String>

親要素のID

children: Vec<String>

子要素のIDリスト

created_at: DateTime<Utc>

作成日時

updated_at: DateTime<Utc>

更新日時

metadata: HashMap<String, Value>

メタデータ

related_items: Vec<String>

関連項目

tags: Vec<String>

タグ

Implementations

impl DocItem

pub fn new(name: String, doc_type: DocType, content: String) -> Self

新しいドキュメント項目を作成

pub fn with_file_path(self, path: PathBuf) -> Self

ファイルパスを設定

pub fn with_line_number(self, line: usize) -> Self

行番号を設定

pub fn with_signature(self, signature: String) -> Self

署名を設定

pub fn with_parent(self, parent_id: String) -> Self

親要素を設定

pub fn with_tag(self, tag: String) -> Self

タグを追加

pub fn with_metadata(self, key: String, value: Value) -> Self

メタデータを設定

pub fn html_id(&self) -> String

HTML IDを生成

pub fn slug(&self) -> String

URLスラグを生成

Trait Implementations

impl Clone for DocItem

fn clone(&self) -> DocItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocItem

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

Formats the value using the given formatter.

impl Default for DocItem

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.