Struct Tier

pub struct Tier { /* private fields */ }

Represents an interval tier in a TextGrid.

Implementations

impl Tier

pub fn new(name: String, xmin: f64, xmax: f64, intervals: Vec<Interval>) -> Tier

impl Tier

pub fn name(&self) -> &String

pub fn xmin(&self) -> &f64

pub fn xmax(&self) -> &f64

pub fn intervals(&self) -> &Vec<Interval>

impl Tier

pub fn intervals_mut(&mut self) -> &mut Vec<Interval>

impl Tier

pub fn set_name(&mut self, val: String) -> &mut Self

impl Tier

pub fn set_xmin<T: Into<Option<bool>>>(&mut self, xmin: f64, warn: T)

Sets the minimum x value for the interval tier.

Arguments

• xmin - The minimum x value to set.
• warn - If true, displays a warning if the minimum point of any interval is greater than xmin.

pub fn set_xmax<W: Into<Option<bool>>>(&mut self, xmax: f64, warn: W)

Sets the maximum x value for the interval tier.

Arguments

• xmax - The maximum x value to set.
• warn - If true, displays a warning if the maximum point of any interval is less than xmax.

pub fn get_size(&self) -> usize

Returns the number of intervals in the interval tier.

pub fn push_interval<W: Into<Option<bool>>>( &mut self, interval: Interval, warn: W, )

Pushes an interval to the interval tier. Calls reorder() to ensure the intervals are sorted by their minimum x value after pushing the interval.

Arguments

• interval - The interval to push.
• warn - If Some(true), displays a warning if the minimum point of the interval is less than the minimum x value of the interval tier.

pub fn push_intervals<W: Into<Option<bool>> + Copy>( &mut self, intervals: Vec<Interval>, warn: W, )

Pushes multiple intervals to the interval tier vector. Calls reorder() afterwards to ensure the intervals are sorted by their minimum x value after pushing the intervals.

Arguments

• intervals - The intervals to push.
• warn - If Some(true), displays a warning if the minimum point of any interval is less than the minimum x value of the interval tier.

pub fn set_intervals<W: Into<Option<bool>>>( &mut self, intervals: Vec<Interval>, warn: W, )

Sets the intervals of the interval tier.

Arguments

• intervals - The intervals to set.
• warn - If Some(true), displays a warning if any interval’s minimum point is less than the minimum x value of the interval tier or if any interval’s maximum point is greater than the maximum x value of the interval tier.

pub fn check_overlaps(&self) -> Option<Vec<(u64, u64)>>

Checks for overlaps in the interval tier. Calls reorder to ensure the intervals are sorted by their minimum x value before checking for overlaps.

Returns

A vector of pairs of the overlapping intervals’ indices or None if there are no overlaps.

pub fn fix_boundaries<P: Into<Option<bool>> + Copy>(&mut self, prefer_first: P)

Fixes gaps/overlaps in the interval tier. Calls reorder to ensure the intervals are sorted by their minimum x value before fixing gaps/overlaps.

Arguments

• prefer_first - true by default. If true, prefers the first interval in the case of a gap. If false, prefers the second interval in the case of a gap.

Panics

If the amount of intervals exceeds isize::MAX.

pub fn fill_gaps(&mut self, text: &str)

Fills gaps within an IntervalTier with the specified text, ensuring no time period is left empty.

Arguments

• text - The text to fill the gaps with.

Panics

If the amount of intervals exceeds isize::MAX.

Trait Implementations

impl Clone for Tier

fn clone(&self) -> Tier

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tier

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

Formats the value using the given formatter.

impl Default for Tier

fn default() -> Tier

Returns the “default value” for a type.

impl Display for Tier

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

Formats the value using the given formatter.