Struct DiagramContentFilter

pub struct DiagramContentFilter { /* private fields */ }

A content filter is created to determine elements of a module to exclude from a diagram. For example, you may wish to create a diagram with only structures and create associations for only target types which are also structures.

Implementations

impl DiagramContentFilter

pub fn with_module_import_filter(self, filter: NameFilter) -> Self

Builder function to set the module import filter.

pub fn filter_stdlib_imports(self) -> Self

Builder function to set the module import filter to exclude all standard library modules.

pub fn with_member_import_filter<F>(self, filter: F) -> Self

where F: Into<QualifiedNameFilter>,

Builder function to set the member import filter.

pub fn with_annotation_filter<F>(self, filter: F) -> Self

where F: Into<QualifiedNameFilter>,

Builder function to set the annotation filter.

pub fn with_definition_filter<F>(self, filter: F) -> Self

where F: Into<DefinitionFilter>,

Builder function to set the definition filter.

pub fn with_definition_filters(self, filter: Vec<DefinitionFilter>) -> Self

Builder function to set the definition filter.

pub fn with_association_filter<F>(self, filter: F) -> Self

where F: Into<DefinitionFilter>,

Builder function to set the association filter.

pub fn with_association_filters(self, filter: Vec<DefinitionFilter>) -> Self

Builder function to set the association filter.

pub fn is_empty(&self) -> bool

Returns true if the filter has no sub-filters, else false.

pub fn draw_import(&self, id: &Import) -> bool

pub fn draw_module_import(&self, id: &Identifier) -> bool

Returns true if the diagram should draw an import relationship to the module named id, else false.

pub fn draw_member_import(&self, id: &QualifiedIdentifier) -> bool

Returns true if the diagram should draw an import relationship to the member named id, else false.

pub fn draw_member_import_pair( &self, nsid: &Identifier, id: &Identifier, ) -> bool

Returns true if the diagram should draw an import relationship to the module named id in module nsid, else false.

pub fn draw_definition(&self, defn: &Definition) -> bool

Returns true if the diagram should draw the definition defn, else false.

pub fn draw_definition_named( &self, subject_kind: DefinitionKind, subject_id: &Identifier, ) -> bool

pub fn draw_member_as_association(&self, defn: &Definition) -> bool

Returns true if the diagram should draw a member as an association (or attribute) depending on it’s target type, else false.

pub fn write_to_file<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Write this filter to the file named file in JSON format.

pub fn write_to_writer<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Write this filter to the provided writer in JSON format.

pub fn read_from_file<P>(file: P) -> Result<Self, Error>

where P: AsRef<Path>,

Read a filter from the file named file in JSON format.

pub fn read_from_reader<R>(reader: R) -> Result<Self, Error>

where R: Read,

Read a filter from the provided reader in JSON format.

Trait Implementations

impl Clone for DiagramContentFilter

fn clone(&self) -> DiagramContentFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagramContentFilter

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

Formats the value using the given formatter.

impl Default for DiagramContentFilter

fn default() -> DiagramContentFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiagramContentFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiagramContentFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.