Struct redact_composer_core::Segment

pub struct Segment {
    pub element: Box<dyn Element>,
    pub timing: Timing,
    pub name: Option<String>,
}

A (type-erased) Element spanning a Timing interval.

Fields

element: Box<dyn Element>

The element this segment represents.

timing: Timing

The timing interval this segment spans.

name: Option<String>

An optional name. When being rendered, this segment’s Rng are seeded with a combined hash of this name as well as the segment’s parent seed.

Implementations

impl Segment

pub fn new(composition_type: impl Element, timing: impl Into<Timing>) -> Segment

Creates a new Segment from a Element which starts/ends according to timing.

pub fn named( name: String, composition_type: impl Element, timing: impl Into<Timing> ) -> Segment

Creates a new Segment from a Element which starts/ends according to timing, and seeded by its name. Useful if you want certain segments to be repeated/reproduced (i.e. be rendered with the same Rng)

pub fn element_as<Element: Element>(&self) -> Option<&Element>

Gets the contained element if its type matches type Element, otherwise, None is returned.

Trait Implementations

impl Debug for Segment

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

Formats the value using the given formatter.

impl RangeBounds<i32> for &Segment

fn start_bound(&self) -> Bound<&i32>

Start index bound.

fn end_bound(&self) -> Bound<&i32>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl RangeBounds<i32> for Segment

fn start_bound(&self) -> Bound<&i32>

Start index bound.

fn end_bound(&self) -> Bound<&i32>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl<'a, T: Element> TryFrom<&'a Segment> for SegmentRef<'a, T>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &'a Segment) -> Result<Self, Self::Error>

Performs the conversion.