Struct cpp_to_rust_generator::cpp_method::CppMethodDoc

pub struct CppMethodDoc {
    pub anchor: String,
    pub html: String,
    pub mismatched_declaration: Option<String>,
    pub url: String,
    pub cross_references: Vec<String>,
}

C++ documentation for a method

Fields

anchor: String

HTML anchor of this documentation entry (used to detect duplicates)

html: String

HTML content

mismatched_declaration: Option<String>

If the documentation parser couldn't find documentation for the exact same method, it can still provide documentation entry for the closest match. In this case, this field should contain C++ declaration of the found method.

url: String

Absolute URL to online documentation page for this method

cross_references: Vec<String>

Absolute documentation URLs encountered in the content

Trait Implementations

impl Debug for CppMethodDoc

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for CppMethodDoc

fn eq(&self, __arg_0: &CppMethodDoc) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &CppMethodDoc) -> bool

This method tests for !=.

impl Eq for CppMethodDoc

impl Clone for CppMethodDoc

fn clone(&self) -> CppMethodDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for CppMethodDoc

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].