Struct wavedrom::AssembledFigure
source · pub struct AssembledFigure<'a> { /* private fields */ }Expand description
A Figure that has been assembled with the Figure::assemble or
Figure::assemble_with_options methods.
An assembled figure contains all the information necessary to perform rendering.
Implementations§
source§impl<'a> AssembledFigure<'a>
impl<'a> AssembledFigure<'a>
sourcepub fn write_svg(&self, writer: &mut impl Write) -> Result<()>
pub fn write_svg(&self, writer: &mut impl Write) -> Result<()>
Render a AssembledFigure into a writer.
sourcepub fn write_svg_with_options(
&self,
writer: &mut impl Write,
options: &RenderOptions
) -> Result<()>
pub fn write_svg_with_options( &self, writer: &mut impl Write, options: &RenderOptions ) -> Result<()>
Render a AssembledFigure into a writer with a set of options.
source§impl<'a> AssembledFigure<'a>
impl<'a> AssembledFigure<'a>
sourcepub fn num_cycles(&self) -> u32
pub fn num_cycles(&self) -> u32
Returns the maximum cycle width over all lines.
sourcepub fn horizontal_scale(&self) -> u16
pub fn horizontal_scale(&self) -> u16
Returns the scaling factor for the horizontal axis.
sourcepub fn has_undefined(&self) -> bool
pub fn has_undefined(&self) -> bool
Returns whether the AssembledFigure contains any CycleState::X
sourcepub fn has_gaps(&self) -> bool
pub fn has_gaps(&self) -> bool
Returns whether the AssembledFigure contains any CycleState::Gap
sourcepub fn has_posedge_marker(&self) -> bool
pub fn has_posedge_marker(&self) -> bool
Returns whether the AssembledFigure contains any CycleState::PosedgeClockMarked
sourcepub fn has_negedge_marker(&self) -> bool
pub fn has_negedge_marker(&self) -> bool
Returns whether the AssembledFigure contains any CycleState::NegedgeClockMarked
sourcepub fn has_group_label_at_depth(&self, depth: u32) -> bool
pub fn has_group_label_at_depth(&self, depth: u32) -> bool
Returns the whether there is a label at group nesting level depth.
sourcepub fn group_nesting(&self) -> u32
pub fn group_nesting(&self) -> u32
Returns the maximum depth of the group nesting.
sourcepub fn lines(&self) -> &[AssembledLine<'a>]
pub fn lines(&self) -> &[AssembledLine<'a>]
Returns the lines that the AssembledFigure contains
sourcepub fn group_markers(&self) -> &[GroupMarker<'a>]
pub fn group_markers(&self) -> &[GroupMarker<'a>]
Returns the markers for the group nestings
sourcepub fn header_text(&self) -> Option<&'a str>
pub fn header_text(&self) -> Option<&'a str>
Returns a potential header text of the AssembledFigure
Returns a potential footer text of the AssembledFigure
sourcepub fn top_cycle_marker(&self) -> Option<CycleEnumerationMarker>
pub fn top_cycle_marker(&self) -> Option<CycleEnumerationMarker>
Returns a CycleEnumerationMarker above the signals of the AssembledFigure
sourcepub fn bottom_cycle_marker(&self) -> Option<CycleEnumerationMarker>
pub fn bottom_cycle_marker(&self) -> Option<CycleEnumerationMarker>
Returns a CycleEnumerationMarker below the signals of the AssembledFigure