Enum DefinitionFilter

pub enum DefinitionFilter {
    Kind {
        kind: DefinitionKind,
    },
    Named {
        names: NameFilter,
    },
    Both {
        kind: DefinitionKind,
        names: NameFilter,
    },
}

A definition filter allows the hiding of definitions in the current module using a combination of DefinitionKind and NameFilter. In a similar way to name filters there are three actions:

1. Apply to all definitions of Kind.
2. Apply to all definitions Named according to a name filter.
3. Apply to all definitions where Both the kind and name filter match.

{
 "definition_filter": [
    {
      "both": {
        "kind": "enum",
        "names": {
          "matches": "_AC$"
        }
      }
    }
  ]
}

use regex::Regex;
use sdml_generate::draw::filter::{
    DefinitionFilter, DefinitionKind, DiagramContentFilter
};

let filter = DiagramContentFilter::default()
    .with_definition_filter(
        DefinitionFilter::Both {
            kind: DefinitionKind::Enum,
            names: Regex::new("_AC$").unwrap().into(),
        }
    );

Variants

Kind

Fields

kind: DefinitionKind

Named

Fields

names: NameFilter

Both

Fields

kind: DefinitionKind

names: NameFilter

Implementations

impl DefinitionFilter

pub fn exclude_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter based on a NameFilter.

pub fn exclude_datatypes() -> Self

Constructor for a filter that excludes all datatype definitions.

pub fn exclude_entities() -> Self

Constructor for a filter that excludes all entity definitions.

pub fn exclude_enums() -> Self

Constructor for a filter that excludes all enum definitions.

pub fn exclude_events() -> Self

Constructor for a filter that excludes all event definitions.

pub fn exclude_properties() -> Self

Constructor for a filter that excludes all property definitions.

pub fn exclude_rdfs() -> Self

Constructor for a filter that excludes all rdf definitions.

pub fn exclude_structures() -> Self

Constructor for a filter that excludes all structure definitions.

pub fn exclude_typeclasses() -> Self

Constructor for a filter that excludes all type-class definitions.

pub fn exclude_unions() -> Self

Constructor for a filter that excludes all union definitions.

pub fn exclude_datatypes_named_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any datatype definition that match the provided NameFilter.

pub fn exclude_entities_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any entity definition that match the provided NameFilter.

pub fn exclude_enums_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any enum definition that match the provided NameFilter.

pub fn exclude_events_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any event definition that match the provided NameFilter.

pub fn exclude_properties_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any property definition that match the provided NameFilter.

pub fn exclude_rdfs_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any rdf definition that match the provided NameFilter.

pub fn exclude_structures_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any structure definition that match the provided NameFilter.

pub fn exclude_typeclasses_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any type-class definition that match the provided NameFilter.

pub fn exclude_unions_named<F>(names: F) -> Self

where F: Into<NameFilter>,

Constructor for a filter that excludes any union definition that match the provided NameFilter.

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

Returns true if the definition defn is excluded, else false.

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

Returns true if a definition of subject_kind and name subject_id is excluded, else false.

Trait Implementations

impl Clone for DefinitionFilter

fn clone(&self) -> DefinitionFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefinitionFilter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DefinitionFilter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(DefinitionKind, NameFilter)> for DefinitionFilter

fn from(value: (DefinitionKind, NameFilter)) -> Self

Converts to this type from the input type.

impl From<DefinitionKind> for DefinitionFilter

fn from(kind: DefinitionKind) -> Self

Converts to this type from the input type.

impl From<NameFilter> for DefinitionFilter

fn from(value: NameFilter) -> Self

Converts to this type from the input type.

impl Serialize for DefinitionFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.