Module Hardcaml.Rtl_attribute

RTL attribute specification. Only relevant to downstream tooling.

type t

Specification of attributes which may be attached to various objects within a RTL design. Such attributes are used to provide implementation hints to down stream CAD tools and do not affect any functionality within Hardcaml.

include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include sig ... end
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : t Bin_prot.Read.vtag_reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t -> t -> int
include Ppx_compare_lib.Comparable.S__local with type t := t
include Ppx_compare_lib.Equal.S with type t := t
val equal : t -> t -> bool
include Ppx_compare_lib.Equal.S__local with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
val hash_fold_t : t Ppx_hash_lib.hash_fold
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparator.S with type t := t
type comparator_witness
module Value : sig ... end

Attribute value types.

module Applies_to : sig ... end
val create : ?applies_to:Applies_to.t list -> ?value:Value.t -> string -> t

Create a new attribute. applies_to, if specified, constrains what type of signal the attribute may be applied to.

val name : t -> string

Returns the attribute name

val value : t -> Value.t option

Returns the attribute value, if any.

val applies_to : t -> Applies_to.t list

Signal types that the attribute may be attached to.

module Vivado : sig ... end

A collection of common Xilinx Vivado attributes.