Module `Display_rules.Rule`

A Rule.t is a predicate on Port.ts that specifies the display format of matching ports.

type t

val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t

val default : t: Default formatting - binary for 1 bit signals, hex otherwise.

val port_name_matches : Re.re -> wave_format:Wave_format.t -> t: Use given format for ports whose name match the regular expression re.

val port_name_is : ?⁠alignment:Wave_format.alignment -> Hardcaml_waveterm__.Import.string -> wave_format:Wave_format.t -> t: Use format for ports with given name.

val port_name_is_one_of : ?⁠alignment:Wave_format.alignment -> wave_format:Wave_format.t -> Hardcaml_waveterm__.Import.string Hardcaml_waveterm__.Import.list -> t: Match any one of a list of names.

val custom : f:(Port.t -> Wave_format.t Hardcaml_waveterm__.Import.option) -> t: In custom f, f returns None to signify no match, or Some format to specify a display format.

val custom_with_alignment : f:(Port.t -> (Wave_format.t * Wave_format.alignment) Hardcaml_waveterm__.Import.option) -> t: Similar tp f, but allows the user to specify the alignment of the wave.