Struct public_api::PublicItem

pub struct PublicItem { /* private fields */ }

Represent a public item of an analyzed crate, i.e. an item that forms part of the public API of a crate. Implements Display so it can be printed. It also implements Ord, but how items are ordered are not stable yet, and will change in later versions.

Implementations

impl PublicItem

pub fn tokens(&self) -> impl Iterator<Item = &Token>

The rendered item as a stream of Tokens

pub fn grouping_cmp(&self, other: &Self) -> Ordering

Special version of cmp that is used to sort public items in a way that makes them grouped logically. For example, struct fields will be put right after the struct they are part of.

Trait Implementations

impl Clone for PublicItem

fn clone(&self) -> PublicItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicItem

We want pretty-printing ("{:#?}") of crate::diff::PublicApiDiff to print each public item as Display, so implement Debug with Display.

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

Formats the value using the given formatter.

impl Display for PublicItem

One of the basic uses cases is printing a sorted Vec of PublicItems. So we implement Display for it.

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

Formats the value using the given formatter.

impl Hash for PublicItem

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 PublicItem

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

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

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

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

impl Eq for PublicItem