Struct proptest::collection::SizeRange

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

The minimum and maximum range/bounds on the size of a collection. The interval must form a subset of [0, std::usize::MAX).

A value like 0..=std::usize::MAX will still be accepted but will silently truncate the maximum to std::usize::MAX - 1.

The Default is 0..PROPTEST_MAX_DEFAULT_SIZE_RANGE. The max can be set with the PROPTEST_MAX_DEFAULT_SIZE_RANGE env var, which defaults to 100.

Implementations

impl SizeRange

pub fn new(range: RangeInclusive<usize>) -> Self

Creates a SizeBounds from a RangeInclusive<usize>.

pub fn with<X>(self, and: X) -> (Self, X)

Merges self together with some other argument producing a product type expected by some implementations of A: Arbitrary in A::Parameters. This can be more ergonomic to work with and may help type inference.

pub fn lift<X: Default>(self) -> (Self, X)

Merges self together with some other argument generated with a default value producing a product type expected by some implementations of A: Arbitrary in A::Parameters. This can be more ergonomic to work with and may help type inference.

pub fn start(&self) -> usize

The lower bound of the range (inclusive).

pub fn start_end_incl(&self) -> (usize, usize)

Extract the ends [low, high] of a SizeRange.

pub fn end_incl(&self) -> usize

The upper bound of the range (inclusive).

pub fn end_excl(&self) -> usize

The upper bound of the range (exclusive).

Trait Implementations

impl Add<usize> for SizeRange

Adds usize to both start and end of the bounds.

Panics if adding to either end overflows usize.

type Output = SizeRange

The resulting type after applying the + operator.

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

Performs the + operation.

impl Arbitrary for SizeRange

type Parameters = ()

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

type Strategy = MapInto<<RangeInclusive<usize> as Arbitrary>::Strategy, SizeRange>

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

fn arbitrary_with(_args: 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 Clone for SizeRange

fn clone(&self) -> SizeRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeRange

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

Formats the value using the given formatter.

impl Default for SizeRange

fn default() -> Self

Constructs a SizeRange equivalent to size_range(0..PROPTEST_MAX_DEFAULT_SIZE_RANGE). The max can be set with the PROPTEST_MAX_DEFAULT_SIZE_RANGE env var, which defaults to 100.

impl From<(usize, usize)> for SizeRange

Given (low: usize, high: usize), then a size range of [low..high) is the result.

fn from((low, high): (usize, usize)) -> Self

Converts to this type from the input type.

impl From<Range<usize>> for SizeRange

Given low .. high, then a size range [low, high) is the result.

fn from(r: Range<usize>) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<usize>> for SizeRange

Given low ..= high, then a size range [low, high] is the result.

fn from(r: RangeInclusive<usize>) -> Self

Converts to this type from the input type.

impl From<RangeTo<usize>> for SizeRange

Given ..high, then a size range [0, high) is the result.

fn from(high: RangeTo<usize>) -> Self

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for SizeRange

Given ..=high, then a size range [0, high] is the result.

fn from(high: RangeToInclusive<usize>) -> Self

Converts to this type from the input type.

impl From<usize> for SizeRange

Given exact, then a size range of [exact, exact] is the result.

fn from(exact: usize) -> Self

Converts to this type from the input type.

impl Hash for SizeRange

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 SizeRange

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SizeRange

impl StructuralPartialEq for SizeRange