Enum BoolWitG

pub enum BoolWitG<B> {
    True(TypeEq<B, Bool<true>>),
    False(TypeEq<B, Bool<false>>),
}

Type witness that B is either Bool<true> or Bool<false>

Use this over BoolWit if you want to write a HasTypeWitness bound and adding a const B: bool parameter would be impossible.

Example

This basic example demonstrates where BoolWitG would be used instead of BoolWit.

use typewit::const_marker::{Bool, BoolWitG};
use typewit::HasTypeWitness;
 
 
trait Boolean: Sized + HasTypeWitness<BoolWitG<Self>> {
    type Not: Boolean<Not = Self>;
}
 
impl Boolean for Bool<true> {
    type Not = Bool<false>;
}
 
impl Boolean for Bool<false> {
    type Not = Bool<true>;
}

Variants

True(TypeEq<B, Bool<true>>)

Witnesses that B == true

False(TypeEq<B, Bool<false>>)

Witnesses that B == false

Implementations

impl<B> BoolWitG<B>

pub const fn is_true(self) -> bool

Whether B == Bool<true>

Example

use typewit::{const_marker::BoolWitG, TypeEq};
 
assert_eq!(BoolWitG::True(TypeEq::NEW).is_true(), true);
assert_eq!(BoolWitG::False(TypeEq::NEW).is_true(), false);

pub const fn is_false(self) -> bool

Whether B == Bool<false>

Example

use typewit::{const_marker::BoolWitG, TypeEq};
 
assert_eq!(BoolWitG::True(TypeEq::NEW).is_false(), false);
assert_eq!(BoolWitG::False(TypeEq::NEW).is_false(), true);

pub const fn to_true(self) -> Option<TypeEq<B, Bool<true>>>

Gets a proof of B == Bool<true>, returns None if B == Bool<false>

Example

use typewit::{const_marker::{Bool, BoolWitG}, TypeEq};
 
assert_eq!(BoolWitG::True(TypeEq::NEW).to_true(), Some(TypeEq::new::<Bool<true>>()));
assert_eq!(BoolWitG::False(TypeEq::NEW).to_true(), None);

pub const fn to_false(self) -> Option<TypeEq<B, Bool<false>>>

Gets a proof of B == Bool<false>, returns None if B == Bool<true>

Example

use typewit::{const_marker::{Bool, BoolWitG}, TypeEq};
 
assert_eq!(BoolWitG::True(TypeEq::NEW).to_false(), None);
assert_eq!(BoolWitG::False(TypeEq::NEW).to_false(), Some(TypeEq::new::<Bool<false>>()));

pub const fn unwrap_true(self) -> TypeEq<B, Bool<true>>

Gets a proof of B == Bool<true>.

Panic

Panics if B == Bool<false>

Example

use typewit::{const_marker::{Bool, BoolWitG}, TypeEq};
 
assert_eq!(BoolWitG::True(TypeEq::NEW).unwrap_true(), TypeEq::new::<Bool<true>>());

pub const fn unwrap_false(self) -> TypeEq<B, Bool<false>>

Gets a proof of B == Bool<false>.

Panic

Panics if B == Bool<true>

Example

use typewit::{const_marker::{Bool, BoolWitG}, TypeEq};
 
assert_eq!(BoolWitG::False(TypeEq::NEW).unwrap_false(), TypeEq::new::<Bool<false>>());

Trait Implementations

impl<B> Clone for BoolWitG<B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for BoolWitG<B>

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

Formats the value using the given formatter.

impl<const B: bool> MakeTypeWitness for BoolWitG<Bool<B>>

const MAKE: Self

A constant with the type witness

impl<B> TypeWitnessTypeArg for BoolWitG<B>

type Arg = B

The type parameter used for type witnesses.

impl<B> Copy for BoolWitG<B>