Struct redact_composer_core::timing::Timing

pub struct Timing {
    pub start: i32,
    pub end: i32,
}

A start-inclusive, end-exclusive i32 range (like Range<i32>) that is copyable, and implements several utility methods.

Fields

start: i32

The inclusive start of this interval.

end: i32

The exclusive end of this interval.

Implementations

impl Timing

pub fn len(&self) -> i32

Returns the length of this timing (self.end - self.start).

pub fn divide_into(&self, size: i32) -> Vec<Timing>

Splits this timing into sequentual pieces of a given size. Returns the resulting Vec.

let split = Timing::from(0..10).divide_into(5);
assert_eq!(split[0], Timing::from(0..5));
assert_eq!(split[1], Timing::from(5..10));

pub fn shifted_by(&self, amount: i32) -> Timing

Returns a new Timing with start/end shifted by the given amount.

assert_eq!(Timing::from(0..10).shifted_by(10), Timing::from(10..20))

pub fn start_shifted_by(&self, amount: i32) -> Timing

Returns a new Timing with the start shifted by the given amount.

assert_eq!(Timing::from(0..10).start_shifted_by(5), Timing::from(5..10))

pub fn end_shifted_by(&self, amount: i32) -> Timing

Returns a new Timing with the end shifted by the given amount.

assert_eq!(Timing::from(0..10).end_shifted_by(-5), Timing::from(0..5))

pub fn contains(&self, item: &i32) -> bool

Checks if a particular &i32 is contained in this Timing.

assert_eq!(Timing::from(1..10).contains(&1), true);
assert_eq!(Timing::from(1..10).contains(&10), false);

pub fn is_empty(&self) -> bool

Checks if this Timing is empty (including negative).

assert_eq!(Timing::from(1..1).is_empty(), true);
assert_eq!(Timing::from(1..0).is_empty(), true);
assert_eq!(Timing::from(1..2).is_empty(), false);

pub fn is_before(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing is before some other Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..1).is_before(&Timing::from(1..2)), true);
assert_eq!(Timing::from(1..2).is_before(&Timing::from(0..1)), false);

pub fn is_after(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing is after some other Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..1).is_after(&Timing::from(1..2)), false);
assert_eq!(Timing::from(1..2).is_after(&Timing::from(0..1)), true);

pub fn is_disjoint_from(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing does not overlap with another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..2).is_disjoint_from(&Timing::from(2..3)), true);
assert_eq!(Timing::from(0..2).is_disjoint_from(&Timing::from(1..3)), false);

pub fn intersects(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing overlaps with another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..2).intersects(&Timing::from(1..3)), true);
assert_eq!(Timing::from(0..2).intersects(&Timing::from(2..3)), false);

pub fn contains_range(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing contains another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..2).contains_range(&Timing::from(0..1)), true);
assert_eq!(Timing::from(0..2).contains_range(&Timing::from(1..3)), false);

pub fn is_contained_by(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing is contained by another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..2).is_contained_by(&Timing::from(0..3)), true);
assert_eq!(Timing::from(0..2).is_contained_by(&Timing::from(0..1)), false);

pub fn begins_within(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing begins within another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..1).begins_within(&Timing::from(0..2)), true);
assert_eq!(Timing::from(0..1).begins_within(&Timing::from(1..2)), false);

pub fn ends_within(&self, other: &impl RangeBounds<i32>) -> bool

Checks if this Timing ends within another Timing (or other RangeBounds<i32>).

assert_eq!(Timing::from(0..2).ends_within(&Timing::from(0..2)), true);
assert_eq!(Timing::from(0..2).ends_within(&Timing::from(0..1)), false);

Trait Implementations

impl Clone for Timing

fn clone(&self) -> Timing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timing

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

Formats the value using the given formatter.

impl From<&Range<i32>> for Timing

fn from(value: &Range<i32>) -> Self

Converts to this type from the input type.

impl From<&Timing> for Range<i32>

fn from(value: &Timing) -> Self

Converts to this type from the input type.

impl From<&Timing> for Timing

fn from(value: &Timing) -> Self

Converts to this type from the input type.

impl From<Range<i32>> for Timing

fn from(value: Range<i32>) -> Self

Converts to this type from the input type.

impl From<Timing> for Range<i32>

fn from(value: Timing) -> Self

Converts to this type from the input type.

impl PartialEq for Timing

fn eq(&self, other: &Timing) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RangeBounds<i32> for Timing

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 Copy for Timing

impl Eq for Timing

impl StructuralPartialEq for Timing