Struct ApidocEntry 

pub struct ApidocEntry {
    pub flags: ApidocFlags,
    pub return_type: Option<String>,
    pub name: String,
    pub args: Vec<ApidocArg>,
    pub source_file: Option<String>,
    pub line_number: Option<usize>,
    pub has_token_pasting: bool,
}

apidocエントリ（関数/マクロの定義）

Fields

flags: ApidocFlags

フラグ

return_type: Option<String>

戻り値の型（なければNone）

name: String

関数/マクロ名

args: Vec<ApidocArg>

引数リスト

source_file: Option<String>

ソースファイル（分かる場合）

line_number: Option<usize>

行番号（分かる場合）

has_token_pasting: bool

トークン合成を行うマクロか（引数型が "name" のような引用符付きの場合）

Implementations

impl ApidocEntry

pub fn parse_line(line: &str) -> Option<Self>

単一行をパース（データ行のみ、コメントはNone） 形式: flags|return_type|name|arg1|arg2|…|argN

pub fn parse_apidoc_line(line: &str) -> Option<Self>

=for apidoc 行をパース 形式: =for apidoc name または: =for apidoc flags|return_type|name|arg1|…

pub fn is_public_api(&self) -> bool

この関数がAPI公開かどうか

pub fn is_macro(&self) -> bool

この関数がマクロかどうか

pub fn is_inline(&self) -> bool

この関数がインラインかどうか

pub fn is_type_param_keyword(ty: &str) -> bool

型パラメータキーワードかどうかを判定

apidoc で type や cast は特殊な引数で、C の型名を表す。 Rust では generic 型パラメータとして扱う。

pub fn type_param_indices(&self) -> Vec<usize>

type/cast パラメータのインデックスを返す

pub fn returns_type_param(&self) -> bool

戻り値型が type または cast かどうか

pub fn is_generic(&self) -> bool

ジェネリック関数として生成すべきか

pub fn is_literal_string_keyword(ty: &str) -> bool

引数がリテラル文字列型かどうか（apidoc で "..." 形式の引数）

例: "literal string", "key", "message" Rust では &str として扱う。

pub fn has_token_arg(&self) -> bool

引数に token 型を持つかどうか

token 型の引数は ## によるトークン合成に使われるため、 このマクロは展開が必要（explicit_expand に追加すべき）

Trait Implementations

impl Clone for ApidocEntry

fn clone(&self) -> ApidocEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApidocEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApidocEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApidocEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.