Struct 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(self, name: String) -> Segment

Gives this Segment a name, used to seed its Rng, and returns the new named version. Useful if you want certain segments to be repeated/reproduced (i.e. be rendered with the same Rng).

pub fn unnamed(self) -> Segment

Removes the Segment’s a name, if it has one, returning the resulting unnamed segment.

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

where Element: 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Segment

fn deserialize<__D>( __deserializer: __D, ) -> Result<Segment, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

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.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl Serialize for Segment

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

where T: Element,

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( value: &'a Segment, ) -> Result<SegmentRef<'a, T>, <SegmentRef<'a, T> as TryFrom<&'a Segment>>::Error>

Performs the conversion.