// Copyright 2024 Gabriel Bjørnager Jensen.
//
// This file is part of Pollex.
//
// Pollex is free software: you can redistribute it
// and/or modify it under the terms of the GNU Af-
// fero General Public License as published by the
// Free Software Foundation, either version 3 of
// the License, or (at your option) any later ver-
// sion.
//
// Pollex is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Affero General Public License for more details.
//
// You should have received a copy of the GNU Af-
// fero General Public License along with Pollex.
// If not, see .
// TODO: This type is usefule for easily being for-
// matted, but is otherwise quite akwardly imple-
// mented (see the constant generic). Could we re-
// it?
use core::fmt::Display;
/// A flag.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u8)]
pub enum Flag {
Off = 0x0,
On = 0x1,
}
impl Flag {
/// Checks if the flag is off.
#[inline(always)]
#[must_use]
pub const fn is_off(self) -> bool { self as u8 == Self::Off as u8 }
/// Checks if the flag is on.
#[inline(always)]
#[must_use]
pub const fn is_on(self) -> bool { self as u8 == Self::On as u8 }
}
impl Display for Flag {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
if self.is_on() {
write!(f, "{C}")?;
}
Ok(())
}
}
impl From for Flag {
#[inline(always)]
fn from(value: bool) -> Self {
if value {
Self::On
} else {
Self::Off
}
}
}
impl From> for bool {
#[inline(always)]
fn from(value: Flag) -> Self { value.is_on() }
}
impl From> for u128 {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}
impl From> for u16 {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}
impl From> for u32 {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}
impl From> for u64 {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}
impl From> for u8 {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}
impl From> for usize {
#[inline(always)]
fn from(value: Flag) -> Self { Self::from(value.is_on()) }
}