Struct ApiSurfaceAnalyzer

Source

pub struct ApiSurfaceAnalyzer { /* private fields */ }

Expand description

API surface analyzer

Implementations§

Source §

impl ApiSurfaceAnalyzer

Source

pub fn new() -> Self

Source

pub fn analyze_api_surface( &self, content: &str, analysis_types: &[String], include_private_apis: bool, ) -> Result<Vec<ApiElement>>

Analyze API surface

Source

pub fn is_public_api_element(&self, name: &str) -> bool

Check if element is considered public API

Source

pub fn get_api_recommendations(&self, elements: &[ApiElement]) -> Vec<String>

Get API recommendations

Source

pub fn analyze_public_api(&self, content: &str) -> Result<Vec<Value>>

Analyze public API elements

Source

pub fn analyze_api_versioning(&self, content: &str) -> Result<Vec<Value>>

Analyze API versioning

Source

pub fn detect_api_breaking_changes(&self, content: &str) -> Result<Vec<Value>>

Detect potential breaking changes

Source

pub fn analyze_api_documentation_coverage( &self, content: &str, ) -> Result<Vec<Value>>

Analyze documentation coverage

Trait Implementations§

Source §

impl Default for ApiSurfaceAnalyzer

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ApiSurfaceAnalyzer

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> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §