Trait moore_svlog_syntax::ast::AnyNodeData

pub trait AnyNodeData {
    fn fmt_indefinite(&self, fmt: &mut Formatter<'_>) -> Result;

    fn as_data(&self) -> &dyn AnyNodeData
    where
        Self: Sized,
    { ... }
    fn get_name(&self) -> Option<Spanned<Name>> { ... }
    fn fmt_definite(&self, fmt: &mut Formatter<'_>) -> Result { ... }
    fn format_indefinite(&self) -> FormatNodeIndefinite<'_>
    where
        Self: Sized,
    { ... }
    fn format_definite(&self) -> FormatNodeDefinite<'_>
    where
        Self: Sized,
    { ... }
    fn to_indefinite_string(&self) -> String
    where
        Self: Sized,
    { ... }
    fn to_definite_string(&self) -> String
    where
        Self: Sized,
    { ... }
}

Common details of an AST node.

Required methods

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

Describe this node for diagnostics in indefinite form, e.g. "entity".

This should not include any node name. Generally, we want to describe the kind of node to the user, for example as in "cannot use at this point in the code".

Loading content...

Provided methods

fn as_data(&self) -> &dyn AnyNodeData where
    Self: Sized, 

fn get_name(&self) -> Option<Spanned<Name>>

Get this node's name, or None if it does not have one.

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

Describe this node for diagnostics in definite form, e.g. "entity 'top'".

If the node has a name, this should include it. Generally, we want to provide enough information for the user to pinpoint an exact node in their design.

fn format_indefinite(&self) -> FormatNodeIndefinite<'_> where
    Self: Sized, 

Describe this node for diagnostics in indefinite form, e.g. "entity".

fn format_definite(&self) -> FormatNodeDefinite<'_> where
    Self: Sized, 

Describe this node for diagnostics in definite form, e.g. "entity 'top'".

fn to_indefinite_string(&self) -> String where
    Self: Sized, 

Describe this node for diagnostics in indefinite form, e.g. "entity".

fn to_definite_string(&self) -> String where
    Self: Sized, 

Describe this node for diagnostics in definite form, e.g. "entity 'top'".

Loading content...

Implementors

impl AnyNodeData for ForeachIndexData

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl AnyNodeData for GenerateCaseData

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl AnyNodeData for ImportItemData

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for DataTypeData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for DpiDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ExprData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ItemData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ModportPortData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PackedDimData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PathSegmentData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PatternFieldData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PortConnData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PortData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for TypeKindData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for TypeOrExpr<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for UnpackedDimData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for VarDimData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ClassDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ContAssignData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for EnumData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for EnumNameData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for GenerateBlockData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for GenerateForData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for GenerateIfData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for GenvarDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ImplicitDataTypeData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ImportDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for InstData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for InstNameData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for InterfaceData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ModportData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ModportNameData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ModportSimplePortData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ModuleData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for NetDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PackageData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ParamDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ParamTypeDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ParamValueDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for PortDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for ProcedureData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for RootData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for SourceFileData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for StmtData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for StructData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for StructMemberData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for SubroutineDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for SubroutinePortData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for SubroutinePrototypeData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for TypeData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for TypedefData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for VarDeclData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a> AnyNodeData for VarDeclNameData<'a>

fn get_name(&self) -> Option<Spanned<Name>>

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

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

impl<'a, T> AnyNodeData for Node<'a, T> where
    T: AnyNodeData, 

Automatically implement AnyNodeData for Node<T> if the inner node implements it.

fn get_name(&self) -> Option<Spanned<Name>>

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

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

Loading content...