Struct public_api::diff::PublicApiDiff
source · pub struct PublicApiDiff {
pub removed: Vec<PublicItem>,
pub changed: Vec<ChangedPublicItem>,
pub added: Vec<PublicItem>,
}
Expand description
The return value of Self::between
. To quickly get a sense of what it
contains, you can pretty-print it:
println!("{:#?}", public_api_diff);
Fields§
§removed: Vec<PublicItem>
Items that have been removed from the public API. A MAJOR change, in semver terminology. Sorted.
changed: Vec<ChangedPublicItem>
Items in the public API that has been changed. Generally a MAJOR change,
but exceptions exist. For example, if the return value of a method is
changed from ExplicitType
to Self
and Self
is the same as
ExplicitType
.
added: Vec<PublicItem>
Items that have been added to public API. A MINOR change, in semver terminology. Sorted.
Implementations§
source§impl PublicApiDiff
impl PublicApiDiff
sourcepub fn between(old: PublicApi, new: PublicApi) -> Self
pub fn between(old: PublicApi, new: PublicApi) -> Self
Allows you to diff the public API between two arbitrary versions of a
library, e.g. different releases. The input parameters old
and new
is the output of two different invocations of
crate::Builder::build
.
Trait Implementations§
source§impl Clone for PublicApiDiff
impl Clone for PublicApiDiff
source§fn clone(&self) -> PublicApiDiff
fn clone(&self) -> PublicApiDiff
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for PublicApiDiff
impl Debug for PublicApiDiff
source§impl PartialEq for PublicApiDiff
impl PartialEq for PublicApiDiff
source§fn eq(&self, other: &PublicApiDiff) -> bool
fn eq(&self, other: &PublicApiDiff) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Eq for PublicApiDiff
impl StructuralEq for PublicApiDiff
impl StructuralPartialEq for PublicApiDiff
Auto Trait Implementations§
impl RefUnwindSafe for PublicApiDiff
impl Send for PublicApiDiff
impl Sync for PublicApiDiff
impl Unpin for PublicApiDiff
impl UnwindSafe for PublicApiDiff
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more