Trait moore_svlog_syntax::ast::AnyNodeData

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

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

Common details of an AST node.

Required methods

pub 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

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

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

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

pub 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.

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

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

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

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

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

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

pub 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

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

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

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

impl AnyNodeData for GenerateCaseData

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

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

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

impl AnyNodeData for ImportItemData

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub 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.

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

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

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

Loading content...