Skip to main content

PhpDoc

php_rs_parser::phpdoc

Struct PhpDoc 

Source 
pub struct PhpDoc<'src> {
    pub summary: Option<&'src str>,
    pub description: Option<&'src str>,
    pub tags: Vec<PhpDocTag<'src>>,
}
Expand description

A parsed PHPDoc block (/** ... */).

Fields§

§summary: Option<&'src str>

The summary line (first line of text before a blank line or tag).

§description: Option<&'src str>

The long description (text after the summary, before the first tag).

§tags: Vec<PhpDocTag<'src>>

Parsed tags in source order.

Trait Implementations§

Source§

impl<'src> Debug for PhpDoc<'src>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'src> Freeze for PhpDoc<'src>

§

impl<'src> RefUnwindSafe for PhpDoc<'src>

§

impl<'src> Send for PhpDoc<'src>

§

impl<'src> Sync for PhpDoc<'src>

§

impl<'src> Unpin for PhpDoc<'src>

§

impl<'src> UnsafeUnpin for PhpDoc<'src>

§

impl<'src> UnwindSafe for PhpDoc<'src>

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> 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, 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.