Struct arithmetic_typing::TupleLen

pub struct TupleLen { /* private fields */ }

Generic tuple length.

A tuple length consists of the two components: an unknown / variable length, such as UnknownLen::Var, and a non-negative increment. These components can be obtained via Self::components().

Static lengths

Tuple lengths can be either static or dynamic. Dynamic lengths are lengths that contain UnknownLen::Dynamic.

Functions, TypeArithmetics, etc. can specify constraints on lengths being static. For example, this is a part of Ops; dynamically sized slices such as [Num] cannot be added / multiplied / etc., even if they are of the same type. This constraint is denoted as len! N, M, ... in the function quantifier, e.g., for<len! N> (['T; N]) -> 'T.

If the constraint fails, an error will be raised with the kind set to ErrorKind::DynamicLen.

Implementations

impl TupleLen

pub fn components(&self) -> (Option<UnknownLen>, usize)

Returns components of this length.

pub fn components_mut(&mut self) -> (Option<&mut UnknownLen>, &mut usize)

Returns mutable references to the components of this length.

Trait Implementations

impl Add<usize> for TupleLen

type Output = TupleLen

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl Clone for TupleLen

fn clone(&self) -> TupleLen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TupleLen

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

Formats the value using the given formatter.

impl Display for TupleLen

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

Formats the value using the given formatter.

impl From<UnknownLen> for TupleLen

fn from(var: UnknownLen) -> Self

Converts to this type from the input type.

impl From<usize> for TupleLen

fn from(exact: usize) -> Self

Converts to this type from the input type.

impl PartialEq for TupleLen

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

impl Eq for TupleLen

impl StructuralPartialEq for TupleLen