archunit

Struct GraphRenderer

Source
pub struct GraphRenderer;
Expand description

Dispatches every output format from the same completed snapshot.

Implementations§

Source§

impl GraphRenderer

Source

pub fn render( snapshot: &GraphReportSnapshot, format: GraphReportFormat, ) -> String

Renders snapshot as format.

Source

pub fn to_dot(snapshot: &GraphReportSnapshot) -> String

Renders Graphviz DOT.

Source

pub fn to_mermaid(snapshot: &GraphReportSnapshot) -> String

Renders Mermaid flowchart source.

Source

pub fn to_d2(snapshot: &GraphReportSnapshot) -> String

Renders D2 diagram source.

Source

pub fn to_csv(snapshot: &GraphReportSnapshot) -> String

Renders aggregated dependency CSV.

Source

pub fn to_json(snapshot: &GraphReportSnapshot) -> String

Renders complete snapshot JSON.

Source

pub fn to_html(snapshot: &GraphReportSnapshot) -> String

Renders a self-contained offline HTML report.

Source

pub fn export( snapshot: &GraphReportSnapshot, format: GraphReportFormat, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Renders snapshot as format and writes it as UTF-8.

Source

pub fn export_as_dot( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports Graphviz DOT as UTF-8.

Source

pub fn export_as_mermaid( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports Mermaid flowchart source as UTF-8.

Source

pub fn export_as_d2( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports D2 diagram source as UTF-8.

Source

pub fn export_as_csv( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports aggregated dependency CSV as UTF-8.

Source

pub fn export_as_json( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports complete snapshot JSON as UTF-8.

Source

pub fn export_as_html( snapshot: &GraphReportSnapshot, output_path: impl AsRef<Path>, ) -> Result<(), ArchUnitError>

Exports a self-contained offline HTML report as UTF-8.

Trait Implementations§

Source§

impl Clone for GraphRenderer

Source§

fn clone(&self) -> GraphRenderer

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 GraphRenderer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GraphRenderer

Source§

fn default() -> GraphRenderer

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

impl Copy for GraphRenderer

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.