Struct Odd 

pub struct Odd<G: KeyPiece>(/* private fields */);

An odd number of type G. It is never zero, so it is stored as a NonZero, which lets Option use zero to represent None and makes Option<Odd<G>> the same size as G.

Implementations

impl<G: KeyPiece> Odd<G>

pub fn new(value: G) -> Option<Self>

Returns value as an Odd, or None if it is even.

pub unsafe fn new_unchecked(value: G) -> Self

Returns value as an Odd, like new, but without checking that it is odd.

Safety

value must be odd.

pub fn get(self) -> G::NonZero

Returns the number as a G::NonZero.

pub fn wrapping_next(self) -> Even<G>

The even number after this one. The largest value of G wraps around to zero.

pub fn previous(self) -> Even<G>

The even number before this one. It never wraps, because the smallest odd number is one.

Trait Implementations

impl<G: Clone + KeyPiece> Clone for Odd<G>

where G::NonZero: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Copy + KeyPiece> Copy for Odd<G>

where G::NonZero: Copy,

impl<G: Debug + KeyPiece> Debug for Odd<G>

where G::NonZero: Debug,

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

Formats the value using the given formatter.

impl<G: Eq + KeyPiece> Eq for Odd<G>

where G::NonZero: Eq,

impl<G: Hash + KeyPiece> Hash for Odd<G>

where G::NonZero: Hash,

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<G: Ord + KeyPiece> Ord for Odd<G>

where G::NonZero: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<G: PartialEq + KeyPiece> PartialEq for Odd<G>

where G::NonZero: PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<G: PartialOrd + KeyPiece> PartialOrd for Odd<G>

where G::NonZero: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<G: PartialEq + KeyPiece> StructuralPartialEq for Odd<G>

where G::NonZero: PartialEq,