Struct diem_proptest_helpers::Index

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

Wrapper for proptest’s [Index][proptest::sample::Index] that allows AsRef to work.

There is no blanket impl<T> AsRef<T> for T, so &[PropIndex] doesn’t work with &[impl AsRef<PropIndex>] (unless an impl gets added upstream). Index does.

Methods from Deref<Target = PropIndex>

pub fn index(&self, size: usize) -> usize

Return the real index that would be used to index a collection of size size.

Panics

Panics if size == 0.

pub fn get<T, 'a>(&self, slice: &'a [T]) -> &'a T

Return a reference to the element in slice that this Index refers to.

A shortcut for &slice[index.index(slice.len())].

pub fn get_mut<T, 'a>(&self, slice: &'a mut [T]) -> &'a mut T

Return a mutable reference to the element in slice that this Index refers to.

A shortcut for &mut slice[index.index(slice.len())].

Trait Implementations

impl Arbitrary for Index

type Parameters = <Index as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<Index as Arbitrary>::Strategy, fn(_: Index) -> Index>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl AsRef<Index> for Index

fn as_ref(&self) -> &PropIndex

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Deref for Index

type Target = Index

The resulting type after dereferencing.

fn deref(&self) -> &PropIndex

Dereferences the value.

impl Copy for Index