archunit

Struct SliceScopeBuilder

Source
pub struct SliceScopeBuilder { /* private fields */ }
Expand description

Immutable scope describing how project files become named slices.

Implementations§

Source§

impl SliceScopeBuilder

Source

pub fn defined_by(self, pattern: impl Into<PatternSpec>) -> Self

Defines slice names through exactly one (**) path capture.

Source

pub fn defined_by_regex(self, expression: impl Into<PatternSpec>) -> Self

Defines slice names through the first capture in a Rust regular expression.

Source

pub fn with_projection(self, projection: SliceProjection) -> Self

Uses a pre-built slice projection, including suffix and identity projections.

Source

pub fn should_not(self) -> NegativeSliceConditionBuilder

Enters the negated mood for forbidden slice dependencies.

Source

pub fn should(self) -> PositiveSliceConditionBuilder

Enters the positive mood for PlantUML diagram adherence.

Source

pub fn to_plantuml(&self) -> Result<String, ArchUnitError>

Extracts the project and renders its current slices as deterministic PlantUML.

Source

pub fn to_plantuml_with( &self, options: &CheckOptions, ) -> Result<String, ArchUnitError>

Renders PlantUML with explicit extraction options.

Source

pub fn export_as_plantuml( &self, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Extracts once and exports the current slices as UTF-8 PlantUML.

Source

pub fn export_as_plantuml_with( &self, output_path: impl AsRef<Path>, options: &CheckOptions, ) -> Result<(), ArchUnitError>

Exports PlantUML with explicit extraction options.

Source

pub const fn project_locator(&self) -> &ProjectLocator

Returns where Cargo project discovery begins.

Source

pub const fn projection(&self) -> &SliceProjection

Returns the immutable file-to-slice projection.

Trait Implementations§

Source§

impl Clone for SliceScopeBuilder

Source§

fn clone(&self) -> SliceScopeBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SliceScopeBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.