Struct koto_runtime::KRange

pub struct KRange(/* private fields */);

The integer range type used by the Koto runtime

See KValue::Range

Implementations

impl KRange

pub fn new(start: Option<i64>, end: Option<(i64, bool)>) -> Self

Initializes a range with the given start and end bounds

The end bound has an additional flag that specifies whether or not the end of the range is inclusive or not.

KRange has an implementation of From for implementations of RangeBounds which might be simpler to use, e.g. KRange::from(10..=20)

pub fn start(&self) -> Option<i64>

Returns the start of the range

pub fn end(&self) -> Option<(i64, bool)>

Returns the end of the range

The return value includes flag stating whether or not the range end is inclusive or not.

pub fn as_sorted_range(&self) -> Range<i64>

Returns a sorted translation of the range with missing boundaries replaced by min/max values

No clamping of the range boundaries is performed (as in KRange::indices), so negative indices will be preserved.

pub fn contains(&self, n: KNumber) -> bool

Returns true if the provided number is within the range

pub fn indices(&self, max_index: usize) -> Range<usize>

Returns the range translated into non-negative indices, suitable for container access

The start index will be clamped to the range 0..=max_index. The end index will be clamped to the range start..=max_index

If the start value is None then the resulting start index will be 0. If the end value is None then the resulting end index will be max_index.

pub fn intersection(&self, other: &KRange) -> Option<Self>

Returns the intersection of two ranges

pub fn is_ascending(&self) -> bool

Returns true if the range’s start is less than or equal to its end

pub fn size(&self) -> Option<usize>

Returns the size of the range if both start and end boundaries are specified

Descending ranges have a non-negative size, i.e. the size is equal to start - end.

pub fn is_bounded(&self) -> bool

Returns true if the range has defined start and end boundaries

pub fn pop_front(&mut self) -> Result<Option<i64>, Error>

Removes and returns the first element in the range.

This is used by RangeIterator and in the VM to iterate over temporary ranges.

Returns an error if the range is not bounded.

pub fn pop_back(&mut self) -> Result<Option<i64>, Error>

Removes and returns the first element in the range.

This is used by RangeIterator and in the VM to iterate over temporary ranges.

Returns an error if the range is not bounded.

Trait Implementations

impl Clone for KRange

fn clone(&self) -> KRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KRange

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

Formats the value using the given formatter.

impl Display for KRange

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

Formats the value using the given formatter.

impl From<KRange> for KValue

fn from(value: KRange) -> Self

Converts to this type from the input type.

impl<R> From<R> for KRange

where R: RangeBounds<i64>,

fn from(range: R) -> Self

Converts to this type from the input type.

impl Hash for KRange

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KRange

fn eq(&self, other: &KRange) -> 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 Eq for KRange

impl StructuralPartialEq for KRange