Struct Docs

pub struct Docs(String, Vec<RustLink>);

Tuple Fields

0: String

1: Vec<RustLink>

Implementations

impl Docs

pub fn from_attrs(attrs: &[Attribute]) -> Self

fn get_doc_lines(attrs: &[Attribute]) -> String

fn get_rust_link(attrs: &[Attribute]) -> Vec<RustLink>

pub fn is_empty(&self) -> bool

pub fn to_markdown( &self, docs_url_gen: &DocsUrlGenerator, style: MarkdownStyle, ) -> String

Convert to markdown

pub fn rust_links(&self) -> &[RustLink]

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Docs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Docs

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

Formats the value using the given formatter.

impl Default for Docs

fn default() -> Docs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Docs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Docs

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Docs

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Docs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Docs

impl StructuralPartialEq for Docs