Struct Odd 

pub struct Odd<T>(/* private fields */);

Proof that a value is odd.

A bare typestate: it carries the proof but has no consuming op in this crate. It ships here because that is where its predicate (Parity) lives. Note that Odd also implies non-zero — zero is even — so it doubles as a “non-zero and odd” proof without a separate OddNonZero type.

Implementations

impl<T> Odd<T>

pub const unsafe fn new_unchecked(value: T) -> Odd<T>

Safety

value must be odd.

pub fn get(self) -> T

The proven-odd value.

impl<T> Odd<T>

where T: Parity + Copy,

pub fn new(value: T) -> Option<Odd<T>>

where T: Parity,

Some iff value is odd. const-callable on nightly when T: [const] Parity, so a const modulus can be proven odd in a const block (no runtime panic path); plain on stable.

impl<T> Odd<T>

where &'a T: for<'a> Parity,

pub fn from_ref(value: &T) -> Option<&Odd<T>>

Zero-cost borrowed proof — relies on the blanket impl Parity for &T (for Copy T) or a non-Copy type’s own Parity for &Self.

impl<T> Odd<T>

where T: CtParity + Copy,

pub fn new_ct(value: T) -> CtOption<Odd<T>>

Constant-time new: None-masked when value is even.

Trait Implementations

impl<T> AsRef<T> for Odd<T>

Borrows the proven-odd value without consuming the proof.

fn as_ref(&self) -> &T

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

impl<T> Clone for Odd<T>

where T: Clone,

fn clone(&self) -> Odd<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Odd<T>

where T: Copy,

impl<T> Debug for Odd<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Eq for Odd<T>

where T: Eq,

impl<T> PartialEq for Odd<T>

where T: PartialEq,

fn eq(&self, other: &Odd<T>) -> 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<T> StructuralPartialEq for Odd<T>

where T: PartialEq,

impl TryFrom<i8> for Odd<i8>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Odd<i8>, TypestateError>

Performs the conversion.

impl TryFrom<i16> for Odd<i16>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Odd<i16>, TypestateError>

Performs the conversion.

impl TryFrom<i32> for Odd<i32>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Odd<i32>, TypestateError>

Performs the conversion.

impl TryFrom<i64> for Odd<i64>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Odd<i64>, TypestateError>

Performs the conversion.

impl TryFrom<i128> for Odd<i128>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Odd<i128>, TypestateError>

Performs the conversion.

impl TryFrom<isize> for Odd<isize>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Odd<isize>, TypestateError>

Performs the conversion.

impl TryFrom<u8> for Odd<u8>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Odd<u8>, TypestateError>

Performs the conversion.

impl TryFrom<u16> for Odd<u16>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Odd<u16>, TypestateError>

Performs the conversion.

impl TryFrom<u32> for Odd<u32>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Odd<u32>, TypestateError>

Performs the conversion.

impl TryFrom<u64> for Odd<u64>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Odd<u64>, TypestateError>

Performs the conversion.

impl TryFrom<u128> for Odd<u128>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Odd<u128>, TypestateError>

Performs the conversion.

impl TryFrom<usize> for Odd<usize>

type Error = TypestateError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Odd<usize>, TypestateError>

Performs the conversion.