Skip to main content

UniformInt

chunkedge::rand::distr::uniform

Struct UniformInt 

pub struct UniformInt<X> { /* private fields */ }
Expand description

The back-end implementing UniformSampler for integer types.

Unless you are implementing UniformSampler for your own type, this type should not be used directly, use Uniform instead.

§Implementation notes

For simplicity, we use the same generic struct UniformInt<X> for all integer types X. This gives us only one field type, X; to store unsigned values of this size, we take use the fact that these conversions are no-ops.

For a closed range, the number of possible numbers we should generate is range = (high - low + 1). To avoid bias, we must ensure that the size of our sample space, zone, is a multiple of range; other values must be rejected (by replacing with a new random sample).

As a special case, we use range = 0 to represent the full range of the result type (i.e. for new_inclusive($ty::MIN, $ty::MAX)).

The optimum zone is the largest product of range which fits in our (unsigned) target type. We calculate this by calculating how many numbers we must reject: reject = (MAX + 1) % range = (MAX - range + 1) % range. Any (large) product of range will suffice, thus in sample_single we multiply by a power of 2 via bit-shifting (faster but may cause more rejections).

The smallest integer PRNGs generate is u32. For 8- and 16-bit outputs we use u32 for our zone and samples (because it’s not slower and because it reduces the chance of having to reject a sample). In this case we cannot store zone in the target type since it is too large, however we know ints_to_reject < range <= $uty::MAX.

An alternative to using a modulus is widening multiply: After a widening multiply by range, the result is in the high word. Then comparing the low word against zone makes sure our distribution is uniform.

§Bias

Unless the unbiased feature flag is used, outputs may have a small bias. In the worst case, bias affects 1 in 2^n samples where n is 56 (i8 and u8), 48 (i16 and u16), 96 (i32 and u32), 64 (i64 and u64), 128 (i128 and u128).

Trait Implementations§

§

impl<X> Clone for UniformInt<X>
where X: Clone,

§

fn clone(&self) -> UniformInt<X>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl<X> Debug for UniformInt<X>
where X: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<X> PartialEq for UniformInt<X>
where X: PartialEq,

§

fn eq(&self, other: &UniformInt<X>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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 UniformSampler for UniformInt<i128>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<i128> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i128> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = i128

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i128>, Error>
where B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<i128>, Error>
where B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i128> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<i16>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<i16> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i16> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = i16

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i16>, Error>
where B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<i16>, Error>
where B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i16> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<i32>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<i32> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i32> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = i32

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i32>, Error>
where B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<i32>, Error>
where B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i32> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<i64>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<i64> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i64> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = i64

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i64>, Error>
where B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<i64>, Error>
where B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i64> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<i8>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<i8> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i8> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = i8

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i8>, Error>
where B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<i8>, Error>
where B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<i8> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<u128>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<u128> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u128> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = u128

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u128>, Error>
where B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<u128>, Error>
where B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u128> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<u16>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<u16> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u16> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = u16

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u16>, Error>
where B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<u16>, Error>
where B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u16> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<u32>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<u32> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u32> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = u32

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u32>, Error>
where B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<u32>, Error>
where B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u32> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<u64>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<u64> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u64> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = u64

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u64>, Error>
where B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>( low_b: B1, high_b: B2, ) -> Result<UniformInt<u64>, Error>
where B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u64> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl UniformSampler for UniformInt<u8>

§

fn sample<R>(&self, rng: &mut R) -> <UniformInt<u8> as UniformSampler>::X
where R: Rng + ?Sized,

Sample from distribution, Lemire’s method, unbiased

§

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u8> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,

Sample single value, Canon’s method, biased

In the worst case, bias affects 1 in 2^n samples where n is 56 (i8), 48 (i16), 96 (i32), 64 (i64), 128 (i128).

§

type X = u8

The type sampled by this implementation.
§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u8>, Error>
where B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
§

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformInt<u8>, Error>
where B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,

Construct self, with inclusive bounds [low, high]. Read more
§

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformInt<u8> as UniformSampler>::X, Error>
where R: Rng + ?Sized, B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high). Read more
§

impl<X> Copy for UniformInt<X>
where X: Copy,

§

impl<X> Eq for UniformInt<X>
where X: Eq,

§

impl<X> StructuralPartialEq for UniformInt<X>

Auto Trait Implementations§

§

impl<X> Freeze for UniformInt<X>
where X: Freeze,

§

impl<X> RefUnwindSafe for UniformInt<X>
where X: RefUnwindSafe,

§

impl<X> Send for UniformInt<X>
where X: Send,

§

impl<X> Sync for UniformInt<X>
where X: Sync,

§

impl<X> Unpin for UniformInt<X>
where X: Unpin,

§

impl<X> UnsafeUnpin for UniformInt<X>
where X: UnsafeUnpin,

§

impl<X> UnwindSafe for UniformInt<X>
where X: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DynEq for T
where T: Any + Eq,

§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<A> Is for A
where A: Any,

§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ConditionalSend for T
where T: Send,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,